syllable-sdk 0.1.0-alpha.9 → 1.0.0-rc.2

package/docs/sdks/permissions/README.md

@@ -0,0 +1,78 @@
+# Permissions
+(*permissions*)
+
+## Overview
+
+Operations related to permissions. A permission is a specific           capability or access level granted to a user within the Syllable system.           Permissions are used to control access to various features and functionalities.
+
+### Available Operations
+
+* [list](#list) - List Permissions
+
+## list
+
+Get all available permissions in the system.
+
+### Example Usage
+
+<!-- UsageSnippet language="typescript" operationID="permissions_list" method="get" path="/api/v1/permissions/" -->
+```typescript
+import { SyllableSDK } from "syllable-sdk";
+
+const syllableSDK = new SyllableSDK({
+  apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
+});
+
+async function run() {
+  const result = await syllableSDK.permissions.list();
+
+  console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { SyllableSDKCore } from "syllable-sdk/core.js";
+import { permissionsList } from "syllable-sdk/funcs/permissionsList.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 permissionsList(syllableSDK);
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("permissionsList failed:", res.error);
+  }
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `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.PermissionGroupResponse[]](../../models/.md)\>**
+
+### Errors
+
+| Error Type      | Status Code     | Content Type    |
+| --------------- | --------------- | --------------- |
+| errors.SDKError | 4XX, 5XX        | \*/\*           |

package/docs/sdks/prompts/README.md

@@ -3,7 +3,7 @@
 
 ## Overview
 
-Operations related to prompts
+Operations related to prompts. A prompt defines the behavior of an           agent by delivering instructions to the LLM about how the agent should behave.           A prompt can be linked to one or more agents. A prompt can also be linked to tools to           allow an agent using the prompt to use them. For more information, see           [Console docs](https://docs.syllable.ai/Resources/Prompts).
 
 ### Available Operations
 
@@ -13,6 +13,7 @@ Operations related to prompts
 * [getById](#getbyid) - Get Prompt By Id
 * [delete](#delete) - Delete Prompt
 * [promptsHistory](#promptshistory) - Get Prompt History
+* [promptGetSupportedLlms](#promptgetsupportedllms) - Get Supported Llm Configs
 
 ## list
 
@@ -20,6 +21,7 @@ List the existing prompts
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="prompts_list" method="get" path="/api/v1/prompts/" -->
 ```typescript
 import { SyllableSDK } from "syllable-sdk";
 
@@ -28,9 +30,18 @@ const syllableSDK = new SyllableSDK({
 });
 
 async function run() {
-  const result = await syllableSDK.prompts.list({});
+  const result = await syllableSDK.prompts.list({
+    page: 0,
+    searchFields: [
+      "name",
+    ],
+    searchFieldValues: [
+      "Some Object Name",
+    ],
+    startDatetime: "2023-01-01T00:00:00Z",
+    endDatetime: "2024-01-01T00:00:00Z",
+  });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -52,16 +63,23 @@ const syllableSDK = new SyllableSDKCore({
 });
 
 async function run() {
-  const res = await promptsList(syllableSDK, {});
-
-  if (!res.ok) {
-    throw res.error;
+  const res = await promptsList(syllableSDK, {
+    page: 0,
+    searchFields: [
+      "name",
+    ],
+    searchFieldValues: [
+      "Some Object Name",
+    ],
+    startDatetime: "2023-01-01T00:00:00Z",
+    endDatetime: "2024-01-01T00:00:00Z",
+  });
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("promptsList failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -78,7 +96,7 @@ run();
 
 ### Response
 
-**Promise\<[components.ListResponsePrompt](../../models/components/listresponseprompt.md)\>**
+**Promise\<[components.ListResponsePromptResponse](../../models/components/listresponsepromptresponse.md)\>**
 
 ### Errors
 
@@ -93,6 +111,7 @@ Create a new prompt
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="prompts_create" method="post" path="/api/v1/prompts/" -->
 ```typescript
 import { SyllableSDK } from "syllable-sdk";
 
@@ -102,17 +121,19 @@ 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: [],
     llmConfig: {
-      provider: "azure_openai",
-      model: "gpt-4o",
       version: "2024-05-13",
       apiVersion: "2024-06-01",
+      temperature: 1,
+      seed: 123,
     },
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -135,24 +156,24 @@ 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: [],
     llmConfig: {
-      provider: "azure_openai",
-      model: "gpt-4o",
       version: "2024-05-13",
       apiVersion: "2024-06-01",
+      temperature: 1,
+      seed: 123,
     },
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("promptsCreate failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -162,14 +183,14 @@ run();
 
 | Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
 | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [components.PromptCreate](../../models/components/promptcreate.md)                                                                                                             | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
+| `request`                                                                                                                                                                      | [components.PromptCreateRequest](../../models/components/promptcreaterequest.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.Prompt](../../models/components/prompt.md)\>**
+**Promise\<[components.PromptResponse](../../models/components/promptresponse.md)\>**
 
 ### Errors
 
@@ -184,6 +205,7 @@ Update an existing prompt
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="prompts_update" method="put" path="/api/v1/prompts/" -->
 ```typescript
 import { SyllableSDK } from "syllable-sdk";
 
@@ -193,18 +215,21 @@ 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: [],
     llmConfig: {
-      provider: "openai",
-      model: "gpt-4o",
       version: "2024-05-13",
       apiVersion: "2024-06-01",
+      temperature: 1,
+      seed: 123,
     },
-    id: 857478,
+    id: 1,
+    editComments: "Updated prompt text to include requirement to not answer questions that aren't about weather.",
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -227,25 +252,26 @@ 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: [],
     llmConfig: {
-      provider: "openai",
-      model: "gpt-4o",
       version: "2024-05-13",
       apiVersion: "2024-06-01",
+      temperature: 1,
+      seed: 123,
     },
-    id: 857478,
+    id: 1,
+    editComments: "Updated prompt text to include requirement to not answer questions that aren't about weather.",
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("promptsUpdate failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -255,14 +281,14 @@ run();
 
 | Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
 | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [components.PromptUpdate](../../models/components/promptupdate.md)                                                                                                             | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
+| `request`                                                                                                                                                                      | [components.PromptUpdateRequest](../../models/components/promptupdaterequest.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.Prompt](../../models/components/prompt.md)\>**
+**Promise\<[components.PromptResponse](../../models/components/promptresponse.md)\>**
 
 ### Errors
 
@@ -277,6 +303,7 @@ Get a prompt by ID
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="prompts_get_by_id" method="get" path="/api/v1/prompts/{prompt_id}" -->
 ```typescript
 import { SyllableSDK } from "syllable-sdk";
 
@@ -286,10 +313,9 @@ const syllableSDK = new SyllableSDK({
 
 async function run() {
   const result = await syllableSDK.prompts.getById({
-    promptId: 931598,
+    promptId: 417330,
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -312,17 +338,14 @@ const syllableSDK = new SyllableSDKCore({
 
 async function run() {
   const res = await promptsGetById(syllableSDK, {
-    promptId: 931598,
+    promptId: 417330,
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("promptsGetById failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -339,7 +362,7 @@ run();
 
 ### Response
 
-**Promise\<[components.Prompt](../../models/components/prompt.md)\>**
+**Promise\<[components.PromptResponse](../../models/components/promptresponse.md)\>**
 
 ### Errors
 
@@ -354,6 +377,7 @@ Delete a prompt
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="prompts_delete" method="delete" path="/api/v1/prompts/{prompt_id}" -->
 ```typescript
 import { SyllableSDK } from "syllable-sdk";
 
@@ -363,11 +387,10 @@ const syllableSDK = new SyllableSDK({
 
 async function run() {
   const result = await syllableSDK.prompts.delete({
-    promptId: 545907,
+    promptId: 982839,
     reason: "<value>",
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -390,18 +413,15 @@ const syllableSDK = new SyllableSDKCore({
 
 async function run() {
   const res = await promptsDelete(syllableSDK, {
-    promptId: 545907,
+    promptId: 982839,
     reason: "<value>",
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("promptsDelete failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -429,10 +449,11 @@ run();
 
 ## promptsHistory
 
-Get a prompt by ID
+Get a list of historical versions of a prompt by its ID
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="prompts_history" method="get" path="/api/v1/prompts/{prompt_id}/history" -->
 ```typescript
 import { SyllableSDK } from "syllable-sdk";
 
@@ -442,10 +463,9 @@ const syllableSDK = new SyllableSDK({
 
 async function run() {
   const result = await syllableSDK.prompts.promptsHistory({
-    promptId: 627932,
+    promptId: 922849,
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -468,17 +488,14 @@ const syllableSDK = new SyllableSDKCore({
 
 async function run() {
   const res = await promptsPromptsHistory(syllableSDK, {
-    promptId: 627932,
+    promptId: 922849,
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("promptsPromptsHistory failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -502,4 +519,72 @@ run();
 | Error Type                 | Status Code                | Content Type               |
 | -------------------------- | -------------------------- | -------------------------- |
 | errors.HTTPValidationError | 422                        | application/json           |
-| errors.SDKError            | 4XX, 5XX                   | \*/\*                      |
+| errors.SDKError            | 4XX, 5XX                   | \*/\*                      |
+
+## promptGetSupportedLlms
+
+Get supported LLM configs.
+
+### Example Usage
+
+<!-- UsageSnippet language="typescript" operationID="prompt_get_supported_llms" method="get" path="/api/v1/prompts/llms/supported" -->
+```typescript
+import { SyllableSDK } from "syllable-sdk";
+
+const syllableSDK = new SyllableSDK({
+  apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
+});
+
+async function run() {
+  const result = await syllableSDK.prompts.promptGetSupportedLlms();
+
+  console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { SyllableSDKCore } from "syllable-sdk/core.js";
+import { promptsPromptGetSupportedLlms } from "syllable-sdk/funcs/promptsPromptGetSupportedLlms.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 promptsPromptGetSupportedLlms(syllableSDK);
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("promptsPromptGetSupportedLlms failed:", res.error);
+  }
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `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.SupportedLlm[]](../../models/.md)\>**
+
+### Errors
+
+| Error Type      | Status Code     | Content Type    |
+| --------------- | --------------- | --------------- |
+| errors.SDKError | 4XX, 5XX        | \*/\*           |