syllable-sdk 0.1.0-alpha.35 → 0.1.0-alpha.37

package/docs/sdks/datasources/README.md

@@ -0,0 +1,417 @@
+# DataSources
+(*dataSources*)
+
+## Overview
+
+Operations related to data sources. A data source is a blob of text that           can be made available to an agent's general info tools to provide more context to the           agent when generating its responses.
+
+### Available Operations
+
+* [list](#list) - List Data Sources
+* [create](#create) - Create Data Source
+* [update](#update) - Update Data Source
+* [getByName](#getbyname) - Get Data Source
+* [dataSourcesDeleteByName](#datasourcesdeletebyname) - Delete Data Source
+
+## list
+
+Fetch metadata about all data sources, not including their text.
+
+### Example Usage
+
+```typescript
+import { SyllableSDK } from "syllable-sdk";
+
+const syllableSDK = new SyllableSDK({
+  apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
+});
+
+async function run() {
+  const result = await syllableSDK.dataSources.list({});
+
+  // Handle the result
+  console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { SyllableSDKCore } from "syllable-sdk/core.js";
+import { dataSourcesList } from "syllable-sdk/funcs/dataSourcesList.js";
+
+// Use `SyllableSDKCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const syllableSDK = new SyllableSDKCore({
+  apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
+});
+
+async function run() {
+  const res = await dataSourcesList(syllableSDK, {});
+
+  if (!res.ok) {
+    throw res.error;
+  }
+
+  const { value: result } = res;
+
+  // Handle the result
+  console.log(result);
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [operations.DataSourcesListRequest](../../models/operations/datasourceslistrequest.md)                                                                                         | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
+| `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
+| `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
+
+### Response
+
+**Promise\<[components.ListResponseDataSourceMetadataResponse](../../models/components/listresponsedatasourcemetadataresponse.md)\>**
+
+### Errors
+
+| Error Type                 | Status Code                | Content Type               |
+| -------------------------- | -------------------------- | -------------------------- |
+| errors.HTTPValidationError | 422                        | application/json           |
+| errors.SDKError            | 4XX, 5XX                   | \*/\*                      |
+
+## create
+
+Create a new data source.
+
+### Example Usage
+
+```typescript
+import { SyllableSDK } from "syllable-sdk";
+
+const syllableSDK = new SyllableSDK({
+  apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
+});
+
+async function run() {
+  const result = await syllableSDK.dataSources.create({
+    name: "<value>",
+    labels: [
+      "Location Info",
+    ],
+    chunk: true,
+    text: "<value>",
+  });
+
+  // Handle the result
+  console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { SyllableSDKCore } from "syllable-sdk/core.js";
+import { dataSourcesCreate } from "syllable-sdk/funcs/dataSourcesCreate.js";
+
+// Use `SyllableSDKCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const syllableSDK = new SyllableSDKCore({
+  apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
+});
+
+async function run() {
+  const res = await dataSourcesCreate(syllableSDK, {
+    name: "<value>",
+    labels: [
+      "Location Info",
+    ],
+    chunk: true,
+    text: "<value>",
+  });
+
+  if (!res.ok) {
+    throw res.error;
+  }
+
+  const { value: result } = res;
+
+  // Handle the result
+  console.log(result);
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [components.DataSourceCreateRequest](../../models/components/datasourcecreaterequest.md)                                                                                       | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
+| `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
+| `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
+
+### Response
+
+**Promise\<[components.DataSourceDetailResponse](../../models/components/datasourcedetailresponse.md)\>**
+
+### Errors
+
+| Error Type                 | Status Code                | Content Type               |
+| -------------------------- | -------------------------- | -------------------------- |
+| errors.HTTPValidationError | 422                        | application/json           |
+| errors.SDKError            | 4XX, 5XX                   | \*/\*                      |
+
+## update
+
+Update an existing data source.
+
+### Example Usage
+
+```typescript
+import { SyllableSDK } from "syllable-sdk";
+
+const syllableSDK = new SyllableSDK({
+  apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
+});
+
+async function run() {
+  const result = await syllableSDK.dataSources.update({
+    name: "<value>",
+    labels: [
+      "Location Info",
+    ],
+    chunk: false,
+    text: "<value>",
+  });
+
+  // Handle the result
+  console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { SyllableSDKCore } from "syllable-sdk/core.js";
+import { dataSourcesUpdate } from "syllable-sdk/funcs/dataSourcesUpdate.js";
+
+// Use `SyllableSDKCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const syllableSDK = new SyllableSDKCore({
+  apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
+});
+
+async function run() {
+  const res = await dataSourcesUpdate(syllableSDK, {
+    name: "<value>",
+    labels: [
+      "Location Info",
+    ],
+    chunk: false,
+    text: "<value>",
+  });
+
+  if (!res.ok) {
+    throw res.error;
+  }
+
+  const { value: result } = res;
+
+  // Handle the result
+  console.log(result);
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [components.DataSourceUpdateRequest](../../models/components/datasourceupdaterequest.md)                                                                                       | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
+| `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
+| `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
+
+### Response
+
+**Promise\<[components.DataSourceDetailResponse](../../models/components/datasourcedetailresponse.md)\>**
+
+### Errors
+
+| Error Type                 | Status Code                | Content Type               |
+| -------------------------- | -------------------------- | -------------------------- |
+| errors.HTTPValidationError | 422                        | application/json           |
+| errors.SDKError            | 4XX, 5XX                   | \*/\*                      |
+
+## getByName
+
+Fetch a given data source, including its text.
+
+### Example Usage
+
+```typescript
+import { SyllableSDK } from "syllable-sdk";
+
+const syllableSDK = new SyllableSDK({
+  apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
+});
+
+async function run() {
+  const result = await syllableSDK.dataSources.getByName({
+    name: "<value>",
+  });
+
+  // Handle the result
+  console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { SyllableSDKCore } from "syllable-sdk/core.js";
+import { dataSourcesGetByName } from "syllable-sdk/funcs/dataSourcesGetByName.js";
+
+// Use `SyllableSDKCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const syllableSDK = new SyllableSDKCore({
+  apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
+});
+
+async function run() {
+  const res = await dataSourcesGetByName(syllableSDK, {
+    name: "<value>",
+  });
+
+  if (!res.ok) {
+    throw res.error;
+  }
+
+  const { value: result } = res;
+
+  // Handle the result
+  console.log(result);
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [operations.DataSourcesGetByNameRequest](../../models/operations/datasourcesgetbynamerequest.md)                                                                               | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
+| `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
+| `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
+
+### Response
+
+**Promise\<[components.DataSourceDetailResponse](../../models/components/datasourcedetailresponse.md)\>**
+
+### Errors
+
+| Error Type                 | Status Code                | Content Type               |
+| -------------------------- | -------------------------- | -------------------------- |
+| errors.HTTPValidationError | 422                        | application/json           |
+| errors.SDKError            | 4XX, 5XX                   | \*/\*                      |
+
+## dataSourcesDeleteByName
+
+Delete a given data source.
+
+### Example Usage
+
+```typescript
+import { SyllableSDK } from "syllable-sdk";
+
+const syllableSDK = new SyllableSDK({
+  apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
+});
+
+async function run() {
+  const result = await syllableSDK.dataSources.dataSourcesDeleteByName({
+    name: "<value>",
+    reason: "<value>",
+  });
+
+  // Handle the result
+  console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { SyllableSDKCore } from "syllable-sdk/core.js";
+import { dataSourcesDataSourcesDeleteByName } from "syllable-sdk/funcs/dataSourcesDataSourcesDeleteByName.js";
+
+// Use `SyllableSDKCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const syllableSDK = new SyllableSDKCore({
+  apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
+});
+
+async function run() {
+  const res = await dataSourcesDataSourcesDeleteByName(syllableSDK, {
+    name: "<value>",
+    reason: "<value>",
+  });
+
+  if (!res.ok) {
+    throw res.error;
+  }
+
+  const { value: result } = res;
+
+  // Handle the result
+  console.log(result);
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [operations.DataSourcesDeleteByNameRequest](../../models/operations/datasourcesdeletebynamerequest.md)                                                                         | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
+| `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
+| `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
+
+### Response
+
+**Promise\<[any](../../models/.md)\>**
+
+### Errors
+
+| Error Type                 | Status Code                | Content Type               |
+| -------------------------- | -------------------------- | -------------------------- |
+| errors.HTTPValidationError | 422                        | application/json           |
+| errors.SDKError            | 4XX, 5XX                   | \*/\*                      |

package/docs/sdks/events/README.md

@@ -23,9 +23,7 @@ const syllableSDK = new SyllableSDK({
 });
 
 async function run() {
-  const result = await syllableSDK.events.list({
-    limit: 25,
-  });
+  const result = await syllableSDK.events.list({});
 
   // Handle the result
   console.log(result);
@@ -49,9 +47,7 @@ const syllableSDK = new SyllableSDKCore({
 });
 
 async function run() {
-  const res = await eventsList(syllableSDK, {
-    limit: 25,
-  });
+  const res = await eventsList(syllableSDK, {});
 
   if (!res.ok) {
     throw res.error;

package/docs/sdks/prompts/README.md

@@ -28,9 +28,7 @@ const syllableSDK = new SyllableSDK({
 });
 
 async function run() {
-  const result = await syllableSDK.prompts.list({
-    limit: 25,
-  });
+  const result = await syllableSDK.prompts.list({});
 
   // Handle the result
   console.log(result);
@@ -54,9 +52,7 @@ const syllableSDK = new SyllableSDKCore({
 });
 
 async function run() {
-  const res = await promptsList(syllableSDK, {
-    limit: 25,
-  });
+  const res = await promptsList(syllableSDK, {});
 
   if (!res.ok) {
     throw res.error;
@@ -109,7 +105,6 @@ async function run() {
     name: "<value>",
     type: "<value>",
     llmConfig: {
-      model: "gpt-4o",
       version: "2024-05-13",
       apiVersion: "2024-06-01",
     },
@@ -141,7 +136,6 @@ async function run() {
     name: "<value>",
     type: "<value>",
     llmConfig: {
-      model: "gpt-4o",
       version: "2024-05-13",
       apiVersion: "2024-06-01",
     },
@@ -198,7 +192,6 @@ async function run() {
     name: "<value>",
     type: "<value>",
     llmConfig: {
-      model: "gpt-4o",
       version: "2024-05-13",
       apiVersion: "2024-06-01",
     },
@@ -231,7 +224,6 @@ async function run() {
     name: "<value>",
     type: "<value>",
     llmConfig: {
-      model: "gpt-4o",
       version: "2024-05-13",
       apiVersion: "2024-06-01",
     },

package/docs/sdks/services/README.md

@@ -25,9 +25,7 @@ const syllableSDK = new SyllableSDK({
 });
 
 async function run() {
-  const result = await syllableSDK.services.list({
-    limit: 25,
-  });
+  const result = await syllableSDK.services.list({});
 
   // Handle the result
   console.log(result);
@@ -51,9 +49,7 @@ const syllableSDK = new SyllableSDKCore({
 });
 
 async function run() {
-  const res = await servicesList(syllableSDK, {
-    limit: 25,
-  });
+  const res = await servicesList(syllableSDK, {});
 
   if (!res.ok) {
     throw res.error;

package/docs/sdks/sessionlabels/README.md

@@ -104,8 +104,8 @@ const syllableSDK = new SyllableSDK({
 async function run() {
   const result = await syllableSDK.sessionLabels.create({
     sessionId: 486589,
-    type: "human-rating",
-    code: "OK",
+    type: "auto-rating",
+    code: "BAD",
     userEmail: "<value>",
     issueCategories: [
       "Silent treatment",
@@ -136,8 +136,8 @@ const syllableSDK = new SyllableSDKCore({
 async function run() {
   const res = await sessionLabelsCreate(syllableSDK, {
     sessionId: 486589,
-    type: "human-rating",
-    code: "OK",
+    type: "auto-rating",
+    code: "BAD",
     userEmail: "<value>",
     issueCategories: [
       "Silent treatment",
@@ -191,9 +191,7 @@ const syllableSDK = new SyllableSDK({
 });
 
 async function run() {
-  const result = await syllableSDK.sessionLabels.list({
-    limit: 25,
-  });
+  const result = await syllableSDK.sessionLabels.list({});
 
   // Handle the result
   console.log(result);
@@ -217,9 +215,7 @@ const syllableSDK = new SyllableSDKCore({
 });
 
 async function run() {
-  const res = await sessionLabelsList(syllableSDK, {
-    limit: 25,
-  });
+  const res = await sessionLabelsList(syllableSDK, {});
 
   if (!res.ok) {
     throw res.error;

package/docs/sdks/sessions/README.md

@@ -26,9 +26,7 @@ const syllableSDK = new SyllableSDK({
 });
 
 async function run() {
-  const result = await syllableSDK.sessions.list({
-    limit: 25,
-  });
+  const result = await syllableSDK.sessions.list({});
 
   // Handle the result
   console.log(result);
@@ -52,9 +50,7 @@ const syllableSDK = new SyllableSDKCore({
 });
 
 async function run() {
-  const res = await sessionsList(syllableSDK, {
-    limit: 25,
-  });
+  const res = await sessionsList(syllableSDK, {});
 
   if (!res.ok) {
     throw res.error;

package/docs/sdks/targets/README.md

@@ -27,9 +27,7 @@ const syllableSDK = new SyllableSDK({
 });
 
 async function run() {
-  const result = await syllableSDK.channels.targets.availableTargets({
-    limit: 25,
-  });
+  const result = await syllableSDK.channels.targets.availableTargets({});
 
   // Handle the result
   console.log(result);
@@ -53,9 +51,7 @@ const syllableSDK = new SyllableSDKCore({
 });
 
 async function run() {
-  const res = await channelsTargetsAvailableTargets(syllableSDK, {
-    limit: 25,
-  });
+  const res = await channelsTargetsAvailableTargets(syllableSDK, {});
 
   if (!res.ok) {
     throw res.error;
@@ -104,9 +100,7 @@ const syllableSDK = new SyllableSDK({
 });
 
 async function run() {
-  const result = await syllableSDK.channels.targets.list({
-    limit: 25,
-  });
+  const result = await syllableSDK.channels.targets.list({});
 
   // Handle the result
   console.log(result);
@@ -130,9 +124,7 @@ const syllableSDK = new SyllableSDKCore({
 });
 
 async function run() {
-  const res = await channelsTargetsList(syllableSDK, {
-    limit: 25,
-  });
+  const res = await channelsTargetsList(syllableSDK, {});
 
   if (!res.ok) {
     throw res.error;
@@ -188,7 +180,6 @@ async function run() {
       channelId: 638424,
       target: "<value>",
       targetMode: "chat",
-      isTest: false,
     },
   });
 
@@ -221,7 +212,6 @@ async function run() {
       channelId: 638424,
       target: "<value>",
       targetMode: "chat",
-      isTest: false,
     },
   });
 
@@ -359,7 +349,6 @@ async function run() {
       channelId: 597129,
       target: "<value>",
       targetMode: "chat",
-      isTest: false,
       id: 991464,
     },
   });
@@ -394,7 +383,6 @@ async function run() {
       channelId: 597129,
       target: "<value>",
       targetMode: "chat",
-      isTest: false,
       id: 991464,
     },
   });