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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "syllable-sdk",
-  "version": "0.1.0-alpha.66",
+  "version": "0.1.0-alpha.68",
   "author": "Speakeasy",
   "main": "./index.js",
   "sideEffects": false,

package/src/lib/config.ts

@@ -57,8 +57,8 @@ export function serverURLFromOptions(options: SDKOptions): URL | null {
 export const SDK_METADATA = {
   language: "typescript",
   openapiDocVersion: "0.0.2",
-  sdkVersion: "0.1.0-alpha.66",
+  sdkVersion: "0.1.0-alpha.68",
   genVersion: "2.512.4",
   userAgent:
-    "speakeasy-sdk/typescript 0.1.0-alpha.66 2.512.4 0.0.2 syllable-sdk",
+    "speakeasy-sdk/typescript 0.1.0-alpha.68 2.512.4 0.0.2 syllable-sdk",
 } as const;

package/src/models/components/agentcreate.ts

@@ -24,6 +24,9 @@ import {
   AgentWaitSound$outboundSchema,
 } from "./agentwaitsound.js";
 
+/**
+ * Request model to create an agent.
+ */
 export type AgentCreate = {
   /**
    * The agent name
@@ -38,7 +41,7 @@ export type AgentCreate = {
    */
   label?: string | null | undefined;
   /**
-   * The agent type. Can be an arbitrary string
+   * The agent type. Must be "ca_v1" currently.
    */
   type: string;
   /**
@@ -46,11 +49,11 @@ export type AgentCreate = {
    */
   promptId: number;
   /**
-   * ID of the custom message that should be delivered at the beginning of a conversation with the agent
+   * Internal ID of the custom message that should be delivered at the beginning of a conversation with the agent
    */
   customMessageId: number;
   /**
-   * ID of the language group associated with the agent
+   * Internal ID of the language group associated with the agent
    */
   languageGroupId?: number | null | undefined;
   /**
@@ -58,11 +61,11 @@ export type AgentCreate = {
    */
   timezone: string;
   /**
-   * User-configured parameter values for the agent's tools
+   * Agent-level static parameter values for the agent's tools, overriding any tool-level defaults
    */
   promptToolDefaults?: Array<AgentToolDefaults> | undefined;
   /**
-   * BCP 47 codes of languages the agent supports
+   * BCP 47 codes of languages the agent supports. (DEPRECATED - pass an empty list here and use language group ID to link agent to a language group instead.)
    *
    * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
    */

package/src/models/components/agentproperties.ts

@@ -5,6 +5,9 @@
 import * as z from "zod";
 import { ClosedEnum } from "../../types/enums.js";
 
+/**
+ * Names of agent fields supported for filtering/sorting on list endpoint.
+ */
 export const AgentProperties = {
   Id: "id",
   Name: "name",
@@ -24,6 +27,9 @@ export const AgentProperties = {
   UpdatedAt: "updated_at",
   LastUpdatedBy: "last_updated_by",
 } as const;
+/**
+ * Names of agent fields supported for filtering/sorting on list endpoint.
+ */
 export type AgentProperties = ClosedEnum<typeof AgentProperties>;
 
 /** @internal */

package/src/models/components/agentresponse.ts

@@ -45,9 +45,10 @@ import {
 } from "./toolresponse.js";
 
 /**
- * When a user interacts with the Syllable system, they do so by communicating with an agent.
+ * Response model for agent operations.
  *
  * @remarks
+ * When a user interacts with the Syllable system, they do so by communicating with an agent.
  * An agent is linked to a prompt, a custom message, and one or more channel targets to define its
  * behavior and capabilities. For more information, see
  * [Console docs](https://docs.syllable.ai/workspaces/Agents).
@@ -66,7 +67,7 @@ export type AgentResponse = {
    */
   label?: string | null | undefined;
   /**
-   * The agent type. Can be an arbitrary string
+   * The agent type. Must be "ca_v1" currently.
    */
   type: string;
   /**
@@ -74,11 +75,11 @@ export type AgentResponse = {
    */
   promptId: number;
   /**
-   * ID of the custom message that should be delivered at the beginning of a conversation with the agent
+   * Internal ID of the custom message that should be delivered at the beginning of a conversation with the agent
    */
   customMessageId: number;
   /**
-   * ID of the language group associated with the agent
+   * Internal ID of the language group associated with the agent
    */
   languageGroupId?: number | null | undefined;
   /**
@@ -86,11 +87,11 @@ export type AgentResponse = {
    */
   timezone: string;
   /**
-   * User-configured parameter values for the agent's tools
+   * Agent-level static parameter values for the agent's tools, overriding any tool-level defaults
    */
   promptToolDefaults?: Array<AgentToolDefaults> | undefined;
   /**
-   * BCP 47 codes of languages the agent supports
+   * BCP 47 codes of languages the agent supports. (DEPRECATED - pass an empty list here and use language group ID to link agent to a language group instead.)
    *
    * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
    */
@@ -116,7 +117,7 @@ export type AgentResponse = {
    */
   waitSound?: string | null | undefined;
   /**
-   * The agent ID
+   * Internal ID of the agent
    */
   id: number;
   /**
@@ -132,7 +133,7 @@ export type AgentResponse = {
    */
   prompt?: PromptResponse | null | undefined;
   /**
-   * The custom message associated with the agent. Will be delivered as a greeting at the beginning of a conversation.
+   * The message associated with the agent. Will be delivered as a greeting at the beginning of a conversation.
    */
   customMessage?: CustomMessageResponse | null | undefined;
   /**

package/src/models/components/agenttooldefaults.ts

@@ -15,7 +15,7 @@ import {
 } from "./agenttoolfielddefault.js";
 
 /**
- * An agent-level configuration of default values for tool parameters for its tools.
+ * Agent-level static parameter values for a tool, overriding any tool-level defaults.
  */
 export type AgentToolDefaults = {
   /**

package/src/models/components/agenttoolfielddefault.ts

@@ -9,7 +9,10 @@ import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 /**
- * An agent-level configuration of default values for tool parameters for a given tool.
+ * Agent-level value for a static parameter on a tool, overriding the tool-level default if one
+ *
+ * @remarks
+ * exists.
  */
 export type AgentToolFieldDefault = {
   /**

package/src/models/components/agentupdate.ts

@@ -24,6 +24,9 @@ import {
   AgentWaitSound$outboundSchema,
 } from "./agentwaitsound.js";
 
+/**
+ * Request model to update an existing agent.
+ */
 export type AgentUpdate = {
   /**
    * The agent name
@@ -38,7 +41,7 @@ export type AgentUpdate = {
    */
   label?: string | null | undefined;
   /**
-   * The agent type. Can be an arbitrary string
+   * The agent type. Must be "ca_v1" currently.
    */
   type: string;
   /**
@@ -46,11 +49,11 @@ export type AgentUpdate = {
    */
   promptId: number;
   /**
-   * ID of the custom message that should be delivered at the beginning of a conversation with the agent
+   * Internal ID of the custom message that should be delivered at the beginning of a conversation with the agent
    */
   customMessageId: number;
   /**
-   * ID of the language group associated with the agent
+   * Internal ID of the language group associated with the agent
    */
   languageGroupId?: number | null | undefined;
   /**
@@ -58,11 +61,11 @@ export type AgentUpdate = {
    */
   timezone: string;
   /**
-   * User-configured parameter values for the agent's tools
+   * Agent-level static parameter values for the agent's tools, overriding any tool-level defaults
    */
   promptToolDefaults?: Array<AgentToolDefaults> | undefined;
   /**
-   * BCP 47 codes of languages the agent supports
+   * BCP 47 codes of languages the agent supports. (DEPRECATED - pass an empty list here and use language group ID to link agent to a language group instead.)
    *
    * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
    */
@@ -88,7 +91,7 @@ export type AgentUpdate = {
    */
   waitSound?: AgentWaitSound | null | undefined;
   /**
-   * The agent ID
+   * Internal ID of the agent
    */
   id: number;
 };

package/src/models/components/agentvoice.ts

@@ -62,7 +62,7 @@ export type AgentVoice = {
   /**
    * Model for an agent voice.
    */
-  model?: AgentVoiceModel | undefined;
+  model: AgentVoiceModel;
   /**
    * Languages supported by the voice
    */
@@ -83,7 +83,7 @@ export const AgentVoice$inboundSchema: z.ZodType<
   display_name: AgentVoiceDisplayName$inboundSchema,
   var_name: AgentVoiceVarName$inboundSchema,
   gender: AgentVoiceGender$inboundSchema,
-  model: AgentVoiceModel$inboundSchema.optional(),
+  model: AgentVoiceModel$inboundSchema,
   supported_languages: z.array(AgentLanguage$inboundSchema),
   deprecated: z.boolean(),
 }).transform((v) => {
@@ -100,7 +100,7 @@ export type AgentVoice$Outbound = {
   display_name: string;
   var_name: string;
   gender: string;
-  model?: string | undefined;
+  model: string;
   supported_languages: Array<AgentLanguage$Outbound>;
   deprecated: boolean;
 };
@@ -115,7 +115,7 @@ export const AgentVoice$outboundSchema: z.ZodType<
   displayName: AgentVoiceDisplayName$outboundSchema,
   varName: AgentVoiceVarName$outboundSchema,
   gender: AgentVoiceGender$outboundSchema,
-  model: AgentVoiceModel$outboundSchema.optional(),
+  model: AgentVoiceModel$outboundSchema,
   supportedLanguages: z.array(AgentLanguage$outboundSchema),
   deprecated: z.boolean(),
 }).transform((v) => {

package/src/models/components/availabletarget.ts

@@ -8,10 +8,28 @@ import { safeParse } from "../../lib/schemas.js";
 import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
+/**
+ * An available organization-level channel target (i.e., one for which a channel target has not
+ *
+ * @remarks
+ * been created in the current suborg).
+ */
 export type AvailableTarget = {
+  /**
+   * Internal ID of the org with which the target is associated.
+   */
   organizationId: number;
+  /**
+   * Internal ID of the channel with which the target is associated.
+   */
   channelId: number;
+  /**
+   * Name of the channel with which the target is associated.
+   */
   channelName: string | null;
+  /**
+   * Org-level target.
+   */
   target: string;
 };
 

package/src/models/components/availabletargetproperties.ts

@@ -5,11 +5,17 @@
 import * as z from "zod";
 import { ClosedEnum } from "../../types/enums.js";
 
+/**
+ * Names of target fields supported for filtering/sorting on available targets list endpoint.
+ */
 export const AvailableTargetProperties = {
   ChannelId: "channel_id",
   ChannelName: "channel_name",
   Target: "target",
 } as const;
+/**
+ * Names of target fields supported for filtering/sorting on available targets list endpoint.
+ */
 export type AvailableTargetProperties = ClosedEnum<
   typeof AvailableTargetProperties
 >;

package/src/models/components/channelproperties.ts

@@ -5,12 +5,18 @@
 import * as z from "zod";
 import { ClosedEnum } from "../../types/enums.js";
 
+/**
+ * Names of channel fields supported for filtering/sorting on list endpoint.
+ */
 export const ChannelProperties = {
   Id: "id",
   Name: "name",
   ChannelService: "channel_service",
   SupportedModes: "supported_modes",
 } as const;
+/**
+ * Names of channel fields supported for filtering/sorting on list endpoint.
+ */
 export type ChannelProperties = ClosedEnum<typeof ChannelProperties>;
 
 /** @internal */

package/src/models/components/channeltargetcreaterequest.ts

@@ -13,17 +13,20 @@ import {
   TargetModes$outboundSchema,
 } from "./targetmodes.js";
 
+/**
+ * Request model to create a channel target.
+ */
 export type ChannelTargetCreateRequest = {
   /**
-   * The ID of the agent associated with the channel target
+   * The internal ID of the agent associated with the channel target
    */
   agentId: number;
   /**
-   * The ID of the channel associated with the channel target
+   * The internal ID of the channel associated with the channel target
    */
   channelId: number;
   /**
-   * The name of the channel target (must correspond to an organization-level target)
+   * The name of the channel target. Must correspond to an organization-level target (available targets can be fetched from `/channels/available-targets`).
    */
   target: string;
   /**
@@ -35,7 +38,7 @@ export type ChannelTargetCreateRequest = {
    */
   fallbackTarget?: string | null | undefined;
   /**
-   * Whether the channel target is intended for testing. If true, any sessions created through this target will be labeled as test.
+   * Whether the channel target is intended for testing. If true, any sessions created through this target will be labeled as a test session (i.e., will not be included in dashboard data and can easily be filtered out in the Sessions screen in the SyllableConsole).
    */
   isTest?: boolean | undefined;
 };

package/src/models/components/channeltargetproperties.ts

@@ -5,6 +5,12 @@
 import * as z from "zod";
 import { ClosedEnum } from "../../types/enums.js";
 
+/**
+ * Names of channel target fields supported for filtering/sorting on full channel targets list
+ *
+ * @remarks
+ * endpoint.
+ */
 export const ChannelTargetProperties = {
   Id: "id",
   ChannelId: "channel_id",
@@ -16,6 +22,12 @@ export const ChannelTargetProperties = {
   IsTest: "is_test",
   UpdatedAt: "updated_at",
 } as const;
+/**
+ * Names of channel target fields supported for filtering/sorting on full channel targets list
+ *
+ * @remarks
+ * endpoint.
+ */
 export type ChannelTargetProperties = ClosedEnum<
   typeof ChannelTargetProperties
 >;

package/src/models/components/channeltargetresponse.ts

@@ -20,23 +20,24 @@ import {
 } from "./targetmodes.js";
 
 /**
- * A channel target links a channel to an agent, allowing users to communicate with the agent
+ * Response model for channel target operations.
  *
  * @remarks
+ * A channel target links a channel to an agent, allowing users to communicate with the agent
  * through that channel. For more information, see
  * [Console docs](https://docs.syllable.ai/Resources/Channels).
  */
 export type ChannelTargetResponse = {
   /**
-   * The ID of the agent associated with the channel target
+   * The internal ID of the agent associated with the channel target
    */
   agentId: number;
   /**
-   * The ID of the channel associated with the channel target
+   * The internal ID of the channel associated with the channel target
    */
   channelId: number;
   /**
-   * The name of the channel target (must correspond to an organization-level target)
+   * The name of the channel target. Must correspond to an organization-level target (available targets can be fetched from `/channels/available-targets`).
    */
   target: string;
   /**
@@ -48,11 +49,11 @@ export type ChannelTargetResponse = {
    */
   fallbackTarget?: string | null | undefined;
   /**
-   * Whether the channel target is intended for testing. If true, any sessions created through this target will be labeled as test.
+   * Whether the channel target is intended for testing. If true, any sessions created through this target will be labeled as a test session (i.e., will not be included in dashboard data and can easily be filtered out in the Sessions screen in the SyllableConsole).
    */
   isTest?: boolean | undefined;
   /**
-   * The ID of the channel target
+   * The internal ID of the channel target
    */
   id: number;
   /**
@@ -68,7 +69,7 @@ export type ChannelTargetResponse = {
    */
   lastUpdatedBy: string;
   /**
-   * Definition of the agent for the channel target
+   * Definition of the agent with which the channel target is associated.
    */
   agent?: AgentResponse | null | undefined;
 };

package/src/models/components/channeltargetupdaterequest.ts

@@ -13,17 +13,20 @@ import {
   TargetModes$outboundSchema,
 } from "./targetmodes.js";
 
+/**
+ * Request model to update a channel target.
+ */
 export type ChannelTargetUpdateRequest = {
   /**
-   * The ID of the agent associated with the channel target
+   * The internal ID of the agent associated with the channel target
    */
   agentId: number;
   /**
-   * The ID of the channel associated with the channel target
+   * The internal ID of the channel associated with the channel target
    */
   channelId: number;
   /**
-   * The name of the channel target (must correspond to an organization-level target)
+   * The name of the channel target. Must correspond to an organization-level target (available targets can be fetched from `/channels/available-targets`).
    */
   target: string;
   /**
@@ -35,11 +38,11 @@ export type ChannelTargetUpdateRequest = {
    */
   fallbackTarget?: string | null | undefined;
   /**
-   * Whether the channel target is intended for testing. If true, any sessions created through this target will be labeled as test.
+   * Whether the channel target is intended for testing. If true, any sessions created through this target will be labeled as a test session (i.e., will not be included in dashboard data and can easily be filtered out in the Sessions screen in the SyllableConsole).
    */
   isTest?: boolean | undefined;
   /**
-   * The ID of the channel target
+   * The internal ID of the channel target
    */
   id: number;
 };

package/src/models/components/custommessagecreaterequest.ts

@@ -13,13 +13,16 @@ import {
   CustomMessageRule$outboundSchema,
 } from "./custommessagerule.js";
 
+/**
+ * Request model to create a custom message.
+ */
 export type CustomMessageCreateRequest = {
   /**
    * The name of the custom message
    */
   name: string;
   /**
-   * The text of the custom message
+   * The default message that the agent will deliver if no rules are set or no rules match the current timestamp.
    */
   text: string;
   /**
@@ -30,6 +33,9 @@ export type CustomMessageCreateRequest = {
    * Rules for time-specific message variants
    */
   rules?: Array<CustomMessageRule> | undefined;
+  /**
+   * Type of the custom message (must be "greeting" for now)
+   */
   type?: string | undefined;
 };
 

package/src/models/components/custommessageresponse.ts

@@ -15,9 +15,10 @@ import {
 } from "./custommessagerule.js";
 
 /**
- * A custom message is a pre-configured message delivered by an agent as a greeting at the
+ * Response model for custom message operations.
  *
  * @remarks
+ * A custom message is a pre-configured message delivered by an agent as a greeting at the
  * beginning of a conversation. Multiple agents can use the same custom mesasage. A custom message
  * has one or more rules defined, which allow for different messages to be dynamically selected and
  * delivered at runtime based on the current time and either date or day of the week. For more
@@ -29,7 +30,7 @@ export type CustomMessageResponse = {
    */
   name: string;
   /**
-   * The text of the custom message
+   * The default message that the agent will deliver if no rules are set or no rules match the current timestamp.
    */
   text: string;
   /**
@@ -56,6 +57,9 @@ export type CustomMessageResponse = {
    * The email address of the user who most recently updated the custom message
    */
   lastUpdatedBy: string;
+  /**
+   * Type of the custom message (must be "greeting" for now)
+   */
   type?: string | undefined;
 };
 

package/src/models/components/custommessagerule.ts

@@ -13,6 +13,12 @@ import {
   DayOfWeek$outboundSchema,
 } from "./dayofweek.js";
 
+/**
+ * A rule used to determine whether a custom message should present a variant message based on
+ *
+ * @remarks
+ * the current timestamp.
+ */
 export type CustomMessageRule = {
   /**
    * The description of the rule

package/src/models/components/custommessageupdaterequest.ts

@@ -13,13 +13,16 @@ import {
   CustomMessageRule$outboundSchema,
 } from "./custommessagerule.js";
 
+/**
+ * Request model to update an existing custom message.
+ */
 export type CustomMessageUpdateRequest = {
   /**
    * The name of the custom message
    */
   name: string;
   /**
-   * The text of the custom message
+   * The default message that the agent will deliver if no rules are set or no rules match the current timestamp.
    */
   text: string;
   /**
@@ -34,6 +37,9 @@ export type CustomMessageUpdateRequest = {
    * The ID of the custom message
    */
   id: number;
+  /**
+   * Type of the custom message (must be "greeting" for now)
+   */
   type?: string | undefined;
 };
 

package/src/models/components/dashboardproperties.ts

@@ -5,6 +5,9 @@
 import * as z from "zod";
 import { ClosedEnum } from "../../types/enums.js";
 
+/**
+ * Names of dashboard fields supported for filtering/sorting on list endpoint.
+ */
 export const DashboardProperties = {
   Id: "id",
   Name: "name",
@@ -12,6 +15,9 @@ export const DashboardProperties = {
   Rank: "rank",
   Label: "label",
 } as const;
+/**
+ * Names of dashboard fields supported for filtering/sorting on list endpoint.
+ */
 export type DashboardProperties = ClosedEnum<typeof DashboardProperties>;
 
 /** @internal */

package/src/models/components/dashboardresponse.ts

@@ -21,11 +21,11 @@ export type DashboardResponse = {
    */
   displayName: string;
   /**
-   * Dashboard importance, 0 is the highest
+   * Dashboard importance (0 is the highest)
    */
   rank: number;
   /**
-   * Dashboard label.  Typically report or dashboard
+   * Dashboard label. Typically "report" or "dashboard"
    */
   label: string;
 };

package/src/models/components/dashboardtokenresponse.ts

@@ -29,15 +29,15 @@ export type DashboardTokenResponse = {
    */
   displayName: string;
   /**
-   * Superset URL of the dashboard
+   * Base Superset URL of the dashboard
    */
   supersetUrl: string;
   /**
-   * Dashboard importance, 0 is the highest
+   * Dashboard importance (0 is the highest)
    */
   rank: number;
   /**
-   * Dashboard label.  Typically report or dashboard
+   * Dashboard label. Typically "report" or "dashboard"
    */
   label: string;
 };

package/src/models/components/datasourcecreaterequest.ts

@@ -8,6 +8,9 @@ import { safeParse } from "../../lib/schemas.js";
 import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
+/**
+ * Request model to create a data source.
+ */
 export type DataSourceCreateRequest = {
   /**
    * The data source name. Must be unique within suborg. Cannot contain whitespace.
@@ -30,7 +33,7 @@ export type DataSourceCreateRequest = {
    */
   chunkDelimiter?: string | null | undefined;
   /**
-   * Information that the data source will provide to the agent accessing it.
+   * Information that the data source will provide to the agent accessing it. It is recommended to include a sentence at the beginning providing context to the LLM for the information in the data source.
    */
   text: string;
 };