syllable-sdk 0.0.9 → 0.1.0-alpha

package/src/models/components/prompt.ts

@@ -11,9 +11,6 @@ import {
   LlmConfig$outboundSchema,
 } from "./llmconfig.js";
 
-/**
- * Prompt
- */
 export type Prompt = {
   /**
    * The Prompt name
@@ -23,11 +20,14 @@ export type Prompt = {
    * The type of the prompt
    */
   type: string;
+  /**
+   * The prompt text
+   */
   context?: string | null | undefined;
   /**
    * The tools for the prompt
    */
-  tools?: Array<string> | null | undefined;
+  tools?: Array<string> | undefined;
   /**
    * The configuration for the language model used by the Cortex API.
    */
@@ -36,6 +36,9 @@ export type Prompt = {
    * The Prompt ID
    */
   id: number;
+  /**
+   * The last updated date of the prompt
+   */
   lastUpdated: string | null;
 };
 
@@ -45,7 +48,7 @@ export const Prompt$inboundSchema: z.ZodType<Prompt, z.ZodTypeDef, unknown> = z
     name: z.string(),
     type: z.string(),
     context: z.nullable(z.string()).optional(),
-    tools: z.nullable(z.array(z.string())).optional(),
+    tools: z.array(z.string()).optional(),
     llm_config: LlmConfig$inboundSchema,
     id: z.number().int(),
     last_updated: z.nullable(z.string()),
@@ -61,7 +64,7 @@ export type Prompt$Outbound = {
   name: string;
   type: string;
   context?: string | null | undefined;
-  tools?: Array<string> | null | undefined;
+  tools?: Array<string> | undefined;
   llm_config: LlmConfig$Outbound;
   id: number;
   last_updated: string | null;
@@ -76,7 +79,7 @@ export const Prompt$outboundSchema: z.ZodType<
   name: z.string(),
   type: z.string(),
   context: z.nullable(z.string()).optional(),
-  tools: z.nullable(z.array(z.string())).optional(),
+  tools: z.array(z.string()).optional(),
   llmConfig: LlmConfig$outboundSchema,
   id: z.number().int(),
   lastUpdated: z.nullable(z.string()),

package/src/models/components/promptcreate.ts

@@ -11,9 +11,6 @@ import {
   LlmConfig$outboundSchema,
 } from "./llmconfig.js";
 
-/**
- * PromptCreate
- */
 export type PromptCreate = {
   /**
    * The Prompt name
@@ -23,11 +20,14 @@ export type PromptCreate = {
    * The type of the prompt
    */
   type: string;
+  /**
+   * The prompt text
+   */
   context?: string | null | undefined;
   /**
    * The tools for the prompt
    */
-  tools?: Array<string> | null | undefined;
+  tools?: Array<string> | undefined;
   /**
    * The configuration for the language model used by the Cortex API.
    */
@@ -43,7 +43,7 @@ export const PromptCreate$inboundSchema: z.ZodType<
   name: z.string(),
   type: z.string(),
   context: z.nullable(z.string()).optional(),
-  tools: z.nullable(z.array(z.string())).optional(),
+  tools: z.array(z.string()).optional(),
   llm_config: LlmConfig$inboundSchema,
 }).transform((v) => {
   return remap$(v, {
@@ -56,7 +56,7 @@ export type PromptCreate$Outbound = {
   name: string;
   type: string;
   context?: string | null | undefined;
-  tools?: Array<string> | null | undefined;
+  tools?: Array<string> | undefined;
   llm_config: LlmConfig$Outbound;
 };
 
@@ -69,7 +69,7 @@ export const PromptCreate$outboundSchema: z.ZodType<
   name: z.string(),
   type: z.string(),
   context: z.nullable(z.string()).optional(),
-  tools: z.nullable(z.array(z.string())).optional(),
+  tools: z.array(z.string()).optional(),
   llmConfig: LlmConfig$outboundSchema,
 }).transform((v) => {
   return remap$(v, {

package/src/models/components/schemasbubblegumv2toolstool.ts

@@ -11,9 +11,6 @@ import {
   ToolDefinition$outboundSchema,
 } from "./tooldefinition.js";
 
-/**
- * SchemasBubblegumV2ToolsTool
- */
 export type SchemasBubblegumV2ToolsTool = {
   /**
    * The name of the tool
@@ -22,7 +19,7 @@ export type SchemasBubblegumV2ToolsTool = {
   /**
    * The definition of the tool
    */
-  definition?: ToolDefinition | null | undefined;
+  definition?: ToolDefinition | undefined;
   /**
    * The service this tool belongs to
    */
@@ -31,6 +28,9 @@ export type SchemasBubblegumV2ToolsTool = {
    * The ID of the tool
    */
   id: number;
+  /**
+   * The name of the service this tool belongs to
+   */
   serviceName?: string | null | undefined;
 };
 
@@ -41,7 +41,7 @@ export const SchemasBubblegumV2ToolsTool$inboundSchema: z.ZodType<
   unknown
 > = z.object({
   name: z.string(),
-  definition: z.nullable(ToolDefinition$inboundSchema).optional(),
+  definition: ToolDefinition$inboundSchema.optional(),
   service_id: z.number().int(),
   id: z.number().int(),
   service_name: z.nullable(z.string()).optional(),
@@ -55,7 +55,7 @@ export const SchemasBubblegumV2ToolsTool$inboundSchema: z.ZodType<
 /** @internal */
 export type SchemasBubblegumV2ToolsTool$Outbound = {
   name: string;
-  definition?: ToolDefinition$Outbound | null | undefined;
+  definition?: ToolDefinition$Outbound | undefined;
   service_id: number;
   id: number;
   service_name?: string | null | undefined;
@@ -68,7 +68,7 @@ export const SchemasBubblegumV2ToolsTool$outboundSchema: z.ZodType<
   SchemasBubblegumV2ToolsTool
 > = z.object({
   name: z.string(),
-  definition: z.nullable(ToolDefinition$outboundSchema).optional(),
+  definition: ToolDefinition$outboundSchema.optional(),
   serviceId: z.number().int(),
   id: z.number().int(),
   serviceName: z.nullable(z.string()).optional(),

package/src/models/components/schemascortexv1toolstool.ts

@@ -3,6 +3,7 @@
  */
 
 import * as z from "zod";
+import { ClosedEnum } from "../../types/enums.js";
 import {
   FunctionT,
   FunctionT$inboundSchema,
@@ -10,6 +11,19 @@ import {
   FunctionT$outboundSchema,
 } from "./function.js";
 
+/**
+ * Always `function`.
+ */
+export const SchemasCortexV1ToolsToolType = {
+  Function: "function",
+} as const;
+/**
+ * Always `function`.
+ */
+export type SchemasCortexV1ToolsToolType = ClosedEnum<
+  typeof SchemasCortexV1ToolsToolType
+>;
+
 /**
  * A tool definition to be used by the OpenAI API.
  */
@@ -17,26 +31,47 @@ export type SchemasCortexV1ToolsTool = {
   /**
    * Always `function`.
    */
-  type?: string | null | undefined;
+  type?: "function" | undefined;
   /**
    * The tool definition including the JSON Schema of its parameters.
    */
   function: FunctionT;
 };
 
+/** @internal */
+export const SchemasCortexV1ToolsToolType$inboundSchema: z.ZodNativeEnum<
+  typeof SchemasCortexV1ToolsToolType
+> = z.nativeEnum(SchemasCortexV1ToolsToolType);
+
+/** @internal */
+export const SchemasCortexV1ToolsToolType$outboundSchema: z.ZodNativeEnum<
+  typeof SchemasCortexV1ToolsToolType
+> = SchemasCortexV1ToolsToolType$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace SchemasCortexV1ToolsToolType$ {
+  /** @deprecated use `SchemasCortexV1ToolsToolType$inboundSchema` instead. */
+  export const inboundSchema = SchemasCortexV1ToolsToolType$inboundSchema;
+  /** @deprecated use `SchemasCortexV1ToolsToolType$outboundSchema` instead. */
+  export const outboundSchema = SchemasCortexV1ToolsToolType$outboundSchema;
+}
+
 /** @internal */
 export const SchemasCortexV1ToolsTool$inboundSchema: z.ZodType<
   SchemasCortexV1ToolsTool,
   z.ZodTypeDef,
   unknown
 > = z.object({
-  type: z.nullable(z.string()).optional(),
+  type: z.literal("function").default("function"),
   function: FunctionT$inboundSchema,
 });
 
 /** @internal */
 export type SchemasCortexV1ToolsTool$Outbound = {
-  type?: string | null | undefined;
+  type: "function";
   function: FunctionT$Outbound;
 };
 
@@ -46,7 +81,7 @@ export const SchemasCortexV1ToolsTool$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   SchemasCortexV1ToolsTool
 > = z.object({
-  type: z.nullable(z.string()).optional(),
+  type: z.literal("function").default("function"),
   function: FunctionT$outboundSchema,
 });
 

package/src/models/components/tooldefinition.ts

@@ -3,12 +3,7 @@
  */
 
 import * as z from "zod";
-import {
-  Defaults,
-  Defaults$inboundSchema,
-  Defaults$Outbound,
-  Defaults$outboundSchema,
-} from "./defaults.js";
+import { ClosedEnum } from "../../types/enums.js";
 import {
   HttpEndpoint,
   HttpEndpoint$inboundSchema,
@@ -21,23 +16,218 @@ import {
   SchemasCortexV1ToolsTool$Outbound,
   SchemasCortexV1ToolsTool$outboundSchema,
 } from "./schemascortexv1toolstool.js";
+import {
+  ToolParameterDefault,
+  ToolParameterDefault$inboundSchema,
+  ToolParameterDefault$Outbound,
+  ToolParameterDefault$outboundSchema,
+} from "./toolparameterdefault.js";
+
+export const Type = {
+  Action: "action",
+  Endpoint: "endpoint",
+  Context: "context",
+} as const;
+export type Type = ClosedEnum<typeof Type>;
+
+export type One = {};
+
+/**
+ * The default values for the parameters of the function/tool call.
+ */
+export type Defaults = One | { [k: string]: ToolParameterDefault };
 
 export type Result = {};
 
 /**
- * A tool that can be called from GPT during the conversation.  The tool can result in one of the following actions depending on the `type` field: - `action`:   An `ActionRequest` to return to Bubblegum in `GetResponseResponse`. - `endpoint`:   An HTTP API call to an external tool. Requires the `endpoint` field to be set too. - `context`:   Sets context variables based on the tool arguments, e.g. to change the session language. Only   `language` and `say` context vars are currently supported, but this will be made more generic.  For example, to change the current session language: ``` {   "type": "context",   "tool": {     "function": {       "name": "set_language",       "parameters": {         "language": {           "type": "string",           "description": "The ISO 639 language code to set for the session e.g. 'en-US'."         },         "message": {           "type": "string",           "description": "Inform the caller we're now speaking in the new language."         }       }     }   } } ```  If `defaults` is provided, it will be used as the default values for the parameters of the tool call, if GPT doesn't provide them: ``` "defaults": {   "hospital": "Queens Hospital" } ```  Some special "transform" handling is supported if the value is a dict with a single `transform` key. The parameter value will be transformed by the given `action` before being used as the default value:  Removing an unwanted parameter: ``` "defaults": {   "hospital": {     "transform": {       "action": "remove"     }   } } ```  Add custom parameters from other parameters using Python's `format`: ``` "defaults": {   "hello": {     "transform": {       "format": "Hello, {name}!"     }   } }  Modify a value conditionally, e.g. change a `city` parameter with value "Bronx" to "The Bronx": ``` {   "defaults": {     "city": {       "transform": {         "when": {"operator": "eq", "key": "city", "value": "Bronx"},         "action": "override",         "format": "The {city}"       }     }   } } ```
+ * A tool that can be called from GPT during the conversation.
+ *
+ * @remarks
+ *
+ * The tool can result in one of the following actions depending on the `type` field:
+ * - `action`:
+ *   An `ActionRequest` to return to Bubblegum in `GetResponseResponse`.
+ * - `endpoint`:
+ *   An HTTP API call to an external tool. Requires the `endpoint` field to be set too.
+ * - `context`:
+ *   Sets context variables based on the tool arguments, e.g. to change the session language. Only
+ *   `language` and `say` context vars are currently supported, but this will be made more generic.
+ *
+ * For example, to change the current session language:
+ * ```
+ * {
+ *   "type": "context",
+ *   "tool": {
+ *     "function": {
+ *       "name": "set_language",
+ *       "parameters": {
+ *         "language": {
+ *           "type": "string",
+ *           "description": "The ISO 639 language code to set for the session e.g. 'en-US'."
+ *         },
+ *         "message": {
+ *           "type": "string",
+ *           "description": "Inform the caller we're now speaking in the new language."
+ *         }
+ *       }
+ *     }
+ *   }
+ * }
+ * ```
+ *
+ * If `defaults` is provided, it will be used as the default values for the parameters of the
+ * tool call, if GPT doesn't provide them:
+ * ```
+ * "defaults": {
+ *   "hospital": "Queens Hospital"
+ * }
+ * ```
+ *
+ * Some special "transform" handling is supported if the value is a dict with a single `transform`
+ * key. The parameter value will be transformed by the given `action` before being used as the
+ * default value:
+ *
+ * Removing an unwanted parameter:
+ * ```
+ * "defaults": {
+ *   "hospital": {
+ *     "transform": {
+ *       "action": "remove"
+ *     }
+ *   }
+ * }
+ * ```
+ *
+ * Add custom parameters from other parameters using Python's `format`:
+ * ```
+ * "defaults": {
+ *   "hello": {
+ *     "transform": {
+ *       "format": "Hello, {name}!"
+ *     }
+ *   }
+ * }
+ *
+ * Modify a value conditionally, e.g. change a `city` parameter with value "Bronx" to "The Bronx":
+ * ```
+ * {
+ *   "defaults": {
+ *     "city": {
+ *       "transform": {
+ *         "when": {"operator": "eq", "key": "city", "value": "Bronx"},
+ *         "action": "override",
+ *         "format": "The {city}"
+ *       }
+ *     }
+ *   }
+ * }
+ * ```
  */
 export type ToolDefinition = {
-  type?: string | null | undefined;
+  /**
+   * The action to take when GPT calls the tool.
+   */
+  type?: Type | null | undefined;
   /**
    * The tool definition to be used by the OpenAI API.
    */
   tool: SchemasCortexV1ToolsTool;
+  /**
+   * The configuration for an HTTP API call.
+   */
   endpoint?: HttpEndpoint | null | undefined;
-  defaults?: Defaults | null | undefined;
+  /**
+   * The default values for the parameters of the function/tool call.
+   */
+  defaults?: One | { [k: string]: ToolParameterDefault } | null | undefined;
+  /**
+   * The optional result of the tool call. Only used for `context` tools.
+   */
   result?: Result | null | undefined;
 };
 
+/** @internal */
+export const Type$inboundSchema: z.ZodNativeEnum<typeof Type> = z.nativeEnum(
+  Type,
+);
+
+/** @internal */
+export const Type$outboundSchema: z.ZodNativeEnum<typeof Type> =
+  Type$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace Type$ {
+  /** @deprecated use `Type$inboundSchema` instead. */
+  export const inboundSchema = Type$inboundSchema;
+  /** @deprecated use `Type$outboundSchema` instead. */
+  export const outboundSchema = Type$outboundSchema;
+}
+
+/** @internal */
+export const One$inboundSchema: z.ZodType<One, z.ZodTypeDef, unknown> = z
+  .object({});
+
+/** @internal */
+export type One$Outbound = {};
+
+/** @internal */
+export const One$outboundSchema: z.ZodType<One$Outbound, z.ZodTypeDef, One> = z
+  .object({});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace One$ {
+  /** @deprecated use `One$inboundSchema` instead. */
+  export const inboundSchema = One$inboundSchema;
+  /** @deprecated use `One$outboundSchema` instead. */
+  export const outboundSchema = One$outboundSchema;
+  /** @deprecated use `One$Outbound` instead. */
+  export type Outbound = One$Outbound;
+}
+
+/** @internal */
+export const Defaults$inboundSchema: z.ZodType<
+  Defaults,
+  z.ZodTypeDef,
+  unknown
+> = z.union([
+  z.lazy(() => One$inboundSchema),
+  z.record(ToolParameterDefault$inboundSchema),
+]);
+
+/** @internal */
+export type Defaults$Outbound = One$Outbound | {
+  [k: string]: ToolParameterDefault$Outbound;
+};
+
+/** @internal */
+export const Defaults$outboundSchema: z.ZodType<
+  Defaults$Outbound,
+  z.ZodTypeDef,
+  Defaults
+> = z.union([
+  z.lazy(() => One$outboundSchema),
+  z.record(ToolParameterDefault$outboundSchema),
+]);
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace Defaults$ {
+  /** @deprecated use `Defaults$inboundSchema` instead. */
+  export const inboundSchema = Defaults$inboundSchema;
+  /** @deprecated use `Defaults$outboundSchema` instead. */
+  export const outboundSchema = Defaults$outboundSchema;
+  /** @deprecated use `Defaults$Outbound` instead. */
+  export type Outbound = Defaults$Outbound;
+}
+
 /** @internal */
 export const Result$inboundSchema: z.ZodType<Result, z.ZodTypeDef, unknown> = z
   .object({});
@@ -71,10 +261,15 @@ export const ToolDefinition$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  type: z.nullable(z.string()).optional(),
+  type: z.nullable(Type$inboundSchema).optional(),
   tool: SchemasCortexV1ToolsTool$inboundSchema,
   endpoint: z.nullable(HttpEndpoint$inboundSchema).optional(),
-  defaults: z.nullable(Defaults$inboundSchema).optional(),
+  defaults: z.nullable(
+    z.union([
+      z.lazy(() => One$inboundSchema),
+      z.record(ToolParameterDefault$inboundSchema),
+    ]),
+  ).optional(),
   result: z.nullable(z.lazy(() => Result$inboundSchema)).optional(),
 });
 
@@ -83,7 +278,11 @@ export type ToolDefinition$Outbound = {
   type?: string | null | undefined;
   tool: SchemasCortexV1ToolsTool$Outbound;
   endpoint?: HttpEndpoint$Outbound | null | undefined;
-  defaults?: Defaults$Outbound | null | undefined;
+  defaults?:
+    | One$Outbound
+    | { [k: string]: ToolParameterDefault$Outbound }
+    | null
+    | undefined;
   result?: Result$Outbound | null | undefined;
 };
 
@@ -93,10 +292,15 @@ export const ToolDefinition$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   ToolDefinition
 > = z.object({
-  type: z.nullable(z.string()).optional(),
+  type: z.nullable(Type$outboundSchema).optional(),
   tool: SchemasCortexV1ToolsTool$outboundSchema,
   endpoint: z.nullable(HttpEndpoint$outboundSchema).optional(),
-  defaults: z.nullable(Defaults$outboundSchema).optional(),
+  defaults: z.nullable(
+    z.union([
+      z.lazy(() => One$outboundSchema),
+      z.record(ToolParameterDefault$outboundSchema),
+    ]),
+  ).optional(),
   result: z.nullable(z.lazy(() => Result$outboundSchema)).optional(),
 });
 

package/src/models/components/toolparametertransform.ts

@@ -3,6 +3,7 @@
  */
 
 import * as z from "zod";
+import { ClosedEnum } from "../../types/enums.js";
 import {
   ToolParameterTransformCondition,
   ToolParameterTransformCondition$inboundSchema,
@@ -10,18 +11,56 @@ import {
   ToolParameterTransformCondition$outboundSchema,
 } from "./toolparametertransformcondition.js";
 
+/**
+ * The action to perform on the value: `default` means only set the value (using the `format` field) if the parameter doesn't exist or is empty, `override` means always set the value, and `remove` means remove the parameter value.
+ */
+export const Action = {
+  Default: "default",
+  Override: "override",
+  Remove: "remove",
+} as const;
+/**
+ * The action to perform on the value: `default` means only set the value (using the `format` field) if the parameter doesn't exist or is empty, `override` means always set the value, and `remove` means remove the parameter value.
+ */
+export type Action = ClosedEnum<typeof Action>;
+
 /**
  * A transform to be applied to the value of a parameter.
  */
 export type ToolParameterTransform = {
+  /**
+   * Only apply the transform if the condition is met.
+   */
   when?: ToolParameterTransformCondition | null | undefined;
   /**
    * The action to perform on the value: `default` means only set the value (using the `format` field) if the parameter doesn't exist or is empty, `override` means always set the value, and `remove` means remove the parameter value.
    */
-  action?: string | null | undefined;
+  action?: Action | undefined;
+  /**
+   * The string value to use for the parameter. The value will be evaluated with the Python `str.format` method, for example, `Hello, {name}!`
+   */
   format?: string | null | undefined;
 };
 
+/** @internal */
+export const Action$inboundSchema: z.ZodNativeEnum<typeof Action> = z
+  .nativeEnum(Action);
+
+/** @internal */
+export const Action$outboundSchema: z.ZodNativeEnum<typeof Action> =
+  Action$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace Action$ {
+  /** @deprecated use `Action$inboundSchema` instead. */
+  export const inboundSchema = Action$inboundSchema;
+  /** @deprecated use `Action$outboundSchema` instead. */
+  export const outboundSchema = Action$outboundSchema;
+}
+
 /** @internal */
 export const ToolParameterTransform$inboundSchema: z.ZodType<
   ToolParameterTransform,
@@ -29,14 +68,14 @@ export const ToolParameterTransform$inboundSchema: z.ZodType<
   unknown
 > = z.object({
   when: z.nullable(ToolParameterTransformCondition$inboundSchema).optional(),
-  action: z.nullable(z.string()).optional(),
+  action: Action$inboundSchema.default("default"),
   format: z.nullable(z.string()).optional(),
 });
 
 /** @internal */
 export type ToolParameterTransform$Outbound = {
   when?: ToolParameterTransformCondition$Outbound | null | undefined;
-  action?: string | null | undefined;
+  action: string;
   format?: string | null | undefined;
 };
 
@@ -47,7 +86,7 @@ export const ToolParameterTransform$outboundSchema: z.ZodType<
   ToolParameterTransform
 > = z.object({
   when: z.nullable(ToolParameterTransformCondition$outboundSchema).optional(),
-  action: z.nullable(z.string()).optional(),
+  action: Action$outboundSchema.default("default"),
   format: z.nullable(z.string()).optional(),
 });