syllable-sdk 0.1.0-alpha.66 → 0.1.0-alpha.67

package/docs/sdks/agents/README.md

@@ -122,21 +122,34 @@ const syllableSDK = new SyllableSDK({
 
 async function run() {
   const result = await syllableSDK.agents.create({
-    name: "<value>",
+    name: "Weather agent",
+    description: "Agent for answering questions about weather.",
+    label: "Information",
     type: "ca_v1",
-    promptId: 486589,
-    customMessageId: 638424,
+    promptId: 1,
+    customMessageId: 1,
+    languageGroupId: 1,
     timezone: "America/New_York",
+    promptToolDefaults: [
+      {
+        toolName: "get_weather",
+        defaultValues: [
+          {
+            fieldName: "temperature_unit",
+            defaultValue: "fahrenheit",
+          },
+        ],
+      },
+    ],
     languages: [
       "en-US",
       "es-US",
     ],
     variables: {
-
+      "vars.location_name": "Main Street Pizza",
     },
     toolHeaders: {
-      "key": "<value>",
-      "key1": "<value>",
+      "Authorization": "Basic sometoken",
     },
     sttProvider: "Google STT V2",
     waitSound: "Keyboard 1",
@@ -165,21 +178,34 @@ const syllableSDK = new SyllableSDKCore({
 
 async function run() {
   const res = await agentsCreate(syllableSDK, {
-    name: "<value>",
+    name: "Weather agent",
+    description: "Agent for answering questions about weather.",
+    label: "Information",
     type: "ca_v1",
-    promptId: 486589,
-    customMessageId: 638424,
+    promptId: 1,
+    customMessageId: 1,
+    languageGroupId: 1,
     timezone: "America/New_York",
+    promptToolDefaults: [
+      {
+        toolName: "get_weather",
+        defaultValues: [
+          {
+            fieldName: "temperature_unit",
+            defaultValue: "fahrenheit",
+          },
+        ],
+      },
+    ],
     languages: [
       "en-US",
       "es-US",
     ],
     variables: {
-  
+      "vars.location_name": "Main Street Pizza",
     },
     toolHeaders: {
-      "key": "<value>",
-      "key1": "<value>",
+      "Authorization": "Basic sometoken",
     },
     sttProvider: "Google STT V2",
     waitSound: "Keyboard 1",
@@ -233,27 +259,38 @@ const syllableSDK = new SyllableSDK({
 
 async function run() {
   const result = await syllableSDK.agents.update({
-    name: "<value>",
+    name: "Weather agent",
+    description: "Agent for answering questions about weather.",
+    label: "Information",
     type: "ca_v1",
-    promptId: 857478,
-    customMessageId: 597129,
+    promptId: 1,
+    customMessageId: 1,
+    languageGroupId: 1,
     timezone: "America/Chicago",
+    promptToolDefaults: [
+      {
+        toolName: "get_weather",
+        defaultValues: [
+          {
+            fieldName: "temperature_unit",
+            defaultValue: "fahrenheit",
+          },
+        ],
+      },
+    ],
     languages: [
       "en-US",
       "es-US",
     ],
     variables: {
-      "key": "<value>",
-      "key1": "<value>",
-      "key2": "<value>",
+      "vars.location_name": "Main Street Pizza",
     },
     toolHeaders: {
-      "key": "<value>",
-      "key1": "<value>",
+      "Authorization": "Basic sometoken",
     },
     sttProvider: "Google STT V2",
     waitSound: "Keyboard 1",
-    id: 488852,
+    id: 1,
   });
 
   // Handle the result
@@ -279,27 +316,38 @@ const syllableSDK = new SyllableSDKCore({
 
 async function run() {
   const res = await agentsUpdate(syllableSDK, {
-    name: "<value>",
+    name: "Weather agent",
+    description: "Agent for answering questions about weather.",
+    label: "Information",
     type: "ca_v1",
-    promptId: 857478,
-    customMessageId: 597129,
+    promptId: 1,
+    customMessageId: 1,
+    languageGroupId: 1,
     timezone: "America/Chicago",
+    promptToolDefaults: [
+      {
+        toolName: "get_weather",
+        defaultValues: [
+          {
+            fieldName: "temperature_unit",
+            defaultValue: "fahrenheit",
+          },
+        ],
+      },
+    ],
     languages: [
       "en-US",
       "es-US",
     ],
     variables: {
-      "key": "<value>",
-      "key1": "<value>",
-      "key2": "<value>",
+      "vars.location_name": "Main Street Pizza",
     },
     toolHeaders: {
-      "key": "<value>",
-      "key1": "<value>",
+      "Authorization": "Basic sometoken",
     },
     sttProvider: "Google STT V2",
     waitSound: "Keyboard 1",
-    id: 488852,
+    id: 1,
   });
 
   if (!res.ok) {

package/docs/sdks/custommessages/README.md

@@ -121,11 +121,12 @@ const syllableSDK = new SyllableSDK({
 
 async function run() {
   const result = await syllableSDK.customMessages.create({
-    name: "<value>",
-    text: "<value>",
+    name: "Customer service greeting",
+    text: "Hello and thank you for calling customer service. How can I help you today?",
+    label: "Customer service",
     rules: [
       {
-        description: "delightfully fumigate convection though zowie up bulky electronics",
+        description: "Closed on New Year's Day",
         timeRangeStart: "09:00",
         timeRangeEnd: "17:00",
         date: "2025-01-01",
@@ -137,10 +138,10 @@ async function run() {
           "fr",
         ],
         invert: false,
-        text: "Sorry, we're closed today",
+        text: "Hello, thank you for calling. Sorry, we're closed today.",
       },
       {
-        description: "yuck forager beneath please shadowy foodstuffs welcome",
+        description: "Closed on New Year's Day",
         timeRangeStart: "09:00",
         timeRangeEnd: "17:00",
         date: "2025-01-01",
@@ -151,8 +152,8 @@ async function run() {
           "th",
           "fr",
         ],
-        invert: true,
-        text: "Sorry, we're closed today",
+        invert: false,
+        text: "Hello, thank you for calling. Sorry, we're closed today.",
       },
     ],
   });
@@ -180,11 +181,12 @@ const syllableSDK = new SyllableSDKCore({
 
 async function run() {
   const res = await customMessagesCreate(syllableSDK, {
-    name: "<value>",
-    text: "<value>",
+    name: "Customer service greeting",
+    text: "Hello and thank you for calling customer service. How can I help you today?",
+    label: "Customer service",
     rules: [
       {
-        description: "delightfully fumigate convection though zowie up bulky electronics",
+        description: "Closed on New Year's Day",
         timeRangeStart: "09:00",
         timeRangeEnd: "17:00",
         date: "2025-01-01",
@@ -196,10 +198,10 @@ async function run() {
           "fr",
         ],
         invert: false,
-        text: "Sorry, we're closed today",
+        text: "Hello, thank you for calling. Sorry, we're closed today.",
       },
       {
-        description: "yuck forager beneath please shadowy foodstuffs welcome",
+        description: "Closed on New Year's Day",
         timeRangeStart: "09:00",
         timeRangeEnd: "17:00",
         date: "2025-01-01",
@@ -210,8 +212,8 @@ async function run() {
           "th",
           "fr",
         ],
-        invert: true,
-        text: "Sorry, we're closed today",
+        invert: false,
+        text: "Hello, thank you for calling. Sorry, we're closed today.",
       },
     ],
   });
@@ -264,11 +266,12 @@ const syllableSDK = new SyllableSDK({
 
 async function run() {
   const result = await syllableSDK.customMessages.update({
-    name: "<value>",
-    text: "<value>",
+    name: "Customer service greeting",
+    text: "Hello and thank you for calling customer service. How can I help you today?",
+    label: "Customer service",
     rules: [
       {
-        description: "technician eulogise whereas till mild than during",
+        description: "Closed on New Year's Day",
         timeRangeStart: "09:00",
         timeRangeEnd: "17:00",
         date: "2025-01-01",
@@ -279,26 +282,11 @@ async function run() {
           "th",
           "fr",
         ],
-        invert: true,
-        text: "Sorry, we're closed today",
-      },
-      {
-        description: "qualified cycle woot abseil perfumed fisherman with duh",
-        timeRangeStart: "09:00",
-        timeRangeEnd: "17:00",
-        date: "2025-01-01",
-        daysOfWeek: [
-          "mo",
-          "tu",
-          "we",
-          "th",
-          "fr",
-        ],
-        invert: true,
-        text: "Sorry, we're closed today",
+        invert: false,
+        text: "Hello, thank you for calling. Sorry, we're closed today.",
       },
       {
-        description: "ultimately in likely opera please antelope",
+        description: "Closed on New Year's Day",
         timeRangeStart: "09:00",
         timeRangeEnd: "17:00",
         date: "2025-01-01",
@@ -309,11 +297,11 @@ async function run() {
           "th",
           "fr",
         ],
-        invert: true,
-        text: "Sorry, we're closed today",
+        invert: false,
+        text: "Hello, thank you for calling. Sorry, we're closed today.",
       },
     ],
-    id: 975440,
+    id: 1,
   });
 
   // Handle the result
@@ -339,11 +327,12 @@ const syllableSDK = new SyllableSDKCore({
 
 async function run() {
   const res = await customMessagesUpdate(syllableSDK, {
-    name: "<value>",
-    text: "<value>",
+    name: "Customer service greeting",
+    text: "Hello and thank you for calling customer service. How can I help you today?",
+    label: "Customer service",
     rules: [
       {
-        description: "technician eulogise whereas till mild than during",
+        description: "Closed on New Year's Day",
         timeRangeStart: "09:00",
         timeRangeEnd: "17:00",
         date: "2025-01-01",
@@ -354,26 +343,11 @@ async function run() {
           "th",
           "fr",
         ],
-        invert: true,
-        text: "Sorry, we're closed today",
-      },
-      {
-        description: "qualified cycle woot abseil perfumed fisherman with duh",
-        timeRangeStart: "09:00",
-        timeRangeEnd: "17:00",
-        date: "2025-01-01",
-        daysOfWeek: [
-          "mo",
-          "tu",
-          "we",
-          "th",
-          "fr",
-        ],
-        invert: true,
-        text: "Sorry, we're closed today",
+        invert: false,
+        text: "Hello, thank you for calling. Sorry, we're closed today.",
       },
       {
-        description: "ultimately in likely opera please antelope",
+        description: "Closed on New Year's Day",
         timeRangeStart: "09:00",
         timeRangeEnd: "17:00",
         date: "2025-01-01",
@@ -384,11 +358,11 @@ async function run() {
           "th",
           "fr",
         ],
-        invert: true,
-        text: "Sorry, we're closed today",
+        invert: false,
+        text: "Hello, thank you for calling. Sorry, we're closed today.",
       },
     ],
-    id: 975440,
+    id: 1,
   });
 
   if (!res.ok) {

package/docs/sdks/datasources/README.md

@@ -128,7 +128,13 @@ async function run() {
     ],
     chunk: false,
     chunkDelimiter: "",
-    text: "<value>",
+    text: "The following are names and addresses of pizza shops.\n" +
+    "\n" +
+    "Cool Pizza, 123 Main St.\n" +
+    "\n" +
+    "Really Good Pizza, 456 Water St.\n" +
+    "\n" +
+    "The Best Pizza, 789 Circle Dr.",
   });
 
   // Handle the result
@@ -161,7 +167,13 @@ async function run() {
     ],
     chunk: false,
     chunkDelimiter: "",
-    text: "<value>",
+    text: "The following are names and addresses of pizza shops.\n" +
+    "\n" +
+    "Cool Pizza, 123 Main St.\n" +
+    "\n" +
+    "Really Good Pizza, 456 Water St.\n" +
+    "\n" +
+    "The Best Pizza, 789 Circle Dr.",
   });
 
   if (!res.ok) {
@@ -221,7 +233,13 @@ async function run() {
     chunkDelimiter: "",
     id: 1,
     editComments: "Added new info",
-    text: "<value>",
+    text: "The following are names and addresses of pizza shops.\n" +
+    "\n" +
+    "Cool Pizza, 123 Main St.\n" +
+    "\n" +
+    "Really Good Pizza, 456 Water St.\n" +
+    "\n" +
+    "The Best Pizza, 789 Circle Dr.",
   });
 
   // Handle the result
@@ -256,7 +274,13 @@ async function run() {
     chunkDelimiter: "",
     id: 1,
     editComments: "Added new info",
-    text: "<value>",
+    text: "The following are names and addresses of pizza shops.\n" +
+    "\n" +
+    "Cool Pizza, 123 Main St.\n" +
+    "\n" +
+    "Really Good Pizza, 456 Water St.\n" +
+    "\n" +
+    "The Best Pizza, 789 Circle Dr.",
   });
 
   if (!res.ok) {

package/docs/sdks/languagegroups/README.md

@@ -124,10 +124,16 @@ async function run() {
     name: "Call Center 1 Languages",
     description: "Languages spoken by operators at Call Center 1",
     languageConfigs: [
+      {
+        languageCode: "en-US",
+        voiceProvider: "OpenAI",
+        voiceDisplayName: "Alloy",
+        dtmfCode: 1,
+      },
       {
         languageCode: "es-US",
-        voiceProvider: "ElevenLabs",
-        voiceDisplayName: "Brian",
+        voiceProvider: "Google",
+        voiceDisplayName: "Alejandro",
         dtmfCode: 1,
       },
     ],
@@ -160,10 +166,16 @@ async function run() {
     name: "Call Center 1 Languages",
     description: "Languages spoken by operators at Call Center 1",
     languageConfigs: [
+      {
+        languageCode: "en-US",
+        voiceProvider: "OpenAI",
+        voiceDisplayName: "Alloy",
+        dtmfCode: 1,
+      },
       {
         languageCode: "es-US",
-        voiceProvider: "ElevenLabs",
-        voiceDisplayName: "Brian",
+        voiceProvider: "Google",
+        voiceDisplayName: "Alejandro",
         dtmfCode: 1,
       },
     ],
@@ -222,21 +234,15 @@ async function run() {
     description: "Languages spoken by operators at Call Center 1",
     languageConfigs: [
       {
-        languageCode: "es-US",
-        voiceProvider: "ElevenLabs",
-        voiceDisplayName: "Will",
+        languageCode: "en-US",
+        voiceProvider: "OpenAI",
+        voiceDisplayName: "Alloy",
         dtmfCode: 1,
       },
       {
         languageCode: "es-US",
-        voiceProvider: "ElevenLabs",
-        voiceDisplayName: "Will",
-        dtmfCode: 1,
-      },
-      {
-        languageCode: "yue-HK",
         voiceProvider: "Google",
-        voiceDisplayName: "George",
+        voiceDisplayName: "Alejandro",
         dtmfCode: 1,
       },
     ],
@@ -272,21 +278,15 @@ async function run() {
     description: "Languages spoken by operators at Call Center 1",
     languageConfigs: [
       {
-        languageCode: "es-US",
-        voiceProvider: "ElevenLabs",
-        voiceDisplayName: "Will",
+        languageCode: "en-US",
+        voiceProvider: "OpenAI",
+        voiceDisplayName: "Alloy",
         dtmfCode: 1,
       },
       {
         languageCode: "es-US",
-        voiceProvider: "ElevenLabs",
-        voiceDisplayName: "Will",
-        dtmfCode: 1,
-      },
-      {
-        languageCode: "yue-HK",
         voiceProvider: "Google",
-        voiceDisplayName: "George",
+        voiceDisplayName: "Alejandro",
         dtmfCode: 1,
       },
     ],

package/docs/sdks/prompts/README.md

@@ -122,8 +122,13 @@ const syllableSDK = new SyllableSDK({
 
 async function run() {
   const result = await syllableSDK.prompts.create({
-    name: "<value>",
-    type: "<value>",
+    name: "Weather Agent Prompt",
+    description: "Prompt for a weather agent.",
+    type: "prompt_v1",
+    context: "You are a weather agent. Answer the user's questions about weather and nothing else.",
+    tools: [
+      "summary, hangup",
+    ],
     llmConfig: {
       version: "2024-05-13",
       apiVersion: "2024-06-01",
@@ -153,8 +158,13 @@ const syllableSDK = new SyllableSDKCore({
 
 async function run() {
   const res = await promptsCreate(syllableSDK, {
-    name: "<value>",
-    type: "<value>",
+    name: "Weather Agent Prompt",
+    description: "Prompt for a weather agent.",
+    type: "prompt_v1",
+    context: "You are a weather agent. Answer the user's questions about weather and nothing else.",
+    tools: [
+      "summary, hangup",
+    ],
     llmConfig: {
       version: "2024-05-13",
       apiVersion: "2024-06-01",
@@ -209,13 +219,19 @@ const syllableSDK = new SyllableSDK({
 
 async function run() {
   const result = await syllableSDK.prompts.update({
-    name: "<value>",
-    type: "<value>",
+    name: "Weather Agent Prompt",
+    description: "Prompt for a weather agent.",
+    type: "prompt_v1",
+    context: "You are a weather agent. Answer the user's questions about weather and nothing else.",
+    tools: [
+      "summary, hangup",
+    ],
     llmConfig: {
       version: "2024-05-13",
       apiVersion: "2024-06-01",
     },
-    id: 857478,
+    id: 1,
+    editComments: "Updated prompt text to include requirement to not answer questions that aren't about weather.",
   });
 
   // Handle the result
@@ -241,13 +257,19 @@ const syllableSDK = new SyllableSDKCore({
 
 async function run() {
   const res = await promptsUpdate(syllableSDK, {
-    name: "<value>",
-    type: "<value>",
+    name: "Weather Agent Prompt",
+    description: "Prompt for a weather agent.",
+    type: "prompt_v1",
+    context: "You are a weather agent. Answer the user's questions about weather and nothing else.",
+    tools: [
+      "summary, hangup",
+    ],
     llmConfig: {
       version: "2024-05-13",
       apiVersion: "2024-06-01",
     },
-    id: 857478,
+    id: 1,
+    editComments: "Updated prompt text to include requirement to not answer questions that aren't about weather.",
   });
 
   if (!res.ok) {

package/docs/sdks/services/README.md

@@ -121,8 +121,8 @@ const syllableSDK = new SyllableSDK({
 
 async function run() {
   const result = await syllableSDK.services.create({
-    name: "<value>",
-    description: "yuck vice between gee ugh ha",
+    name: "Weather tools",
+    description: "Service containing tools for fetching weather information",
   });
 
   // Handle the result
@@ -148,8 +148,8 @@ const syllableSDK = new SyllableSDKCore({
 
 async function run() {
   const res = await servicesCreate(syllableSDK, {
-    name: "<value>",
-    description: "yuck vice between gee ugh ha",
+    name: "Weather tools",
+    description: "Service containing tools for fetching weather information",
   });
 
   if (!res.ok) {
@@ -200,9 +200,10 @@ const syllableSDK = new SyllableSDK({
 
 async function run() {
   const result = await syllableSDK.services.update({
-    name: "<value>",
-    description: "awful underneath retention too mobility char innocently dowse restfully",
-    id: 243447,
+    name: "Weather tools",
+    description: "Service containing tools for fetching weather information",
+    id: 1,
+    lastUpdatedComments: "Updated description to correct typo",
   });
 
   // Handle the result
@@ -228,9 +229,10 @@ const syllableSDK = new SyllableSDKCore({
 
 async function run() {
   const res = await servicesUpdate(syllableSDK, {
-    name: "<value>",
-    description: "awful underneath retention too mobility char innocently dowse restfully",
-    id: 243447,
+    name: "Weather tools",
+    description: "Service containing tools for fetching weather information",
+    id: 1,
+    lastUpdatedComments: "Updated description to correct typo",
   });
 
   if (!res.ok) {

package/docs/sdks/sessionlabels/README.md

@@ -103,10 +103,10 @@ const syllableSDK = new SyllableSDK({
 
 async function run() {
   const result = await syllableSDK.sessionLabels.create({
-    sessionId: 486589,
+    sessionId: 1,
     type: "auto-rating",
     code: "BAD",
-    userEmail: "<value>",
+    userEmail: "user@email.com",
     issueCategories: [
       "Silent treatment",
     ],
@@ -135,10 +135,10 @@ const syllableSDK = new SyllableSDKCore({
 
 async function run() {
   const res = await sessionLabelsCreate(syllableSDK, {
-    sessionId: 486589,
+    sessionId: 1,
     type: "auto-rating",
     code: "BAD",
-    userEmail: "<value>",
+    userEmail: "user@email.com",
     issueCategories: [
       "Silent treatment",
     ],