syllable-sdk 0.1.0-alpha.3 → 0.1.0-alpha.30

package/src/models/components/toolcreaterequest.ts

@@ -0,0 +1,187 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { remap as remap$ } from "../../lib/primitives.js";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  ToolDefinition,
+  ToolDefinition$inboundSchema,
+  ToolDefinition$Outbound,
+  ToolDefinition$outboundSchema,
+} from "./tooldefinition.js";
+
+export type ToolCreateRequest = {
+  /**
+   * The name of the tool
+   */
+  name: string;
+  /**
+   * A tool that can be called from an LLM during the conversation.
+   *
+   * @remarks
+   *
+   * The tool can result in one of the following actions depending on the `type` field:
+   * - `action`:
+   *   A request to perform an action.
+   * - `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 the LLM 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"
+   *     }
+   *   }
+   * }
+   *
+   * Using a value from another parameter and converting it to a dictionary:
+   * "defaults": {
+   *   "tags.hospital": "{vars.hospital}",
+   *   "tags.foo": "{params.foo}",
+   *   "foo": {
+   *     "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}"
+   *       }
+   *     }
+   *   }
+   * }
+   *
+   * Some common transform actions can be abbreviated using the `@` prefix to support a string syntax:
+   * "defaults": {
+   *   "foo": "@remove",
+   *   "name": "@override Hello, {name}!"
+   * }
+   */
+  definition: ToolDefinition;
+  /**
+   * The service this tool belongs to
+   */
+  serviceId: number;
+};
+
+/** @internal */
+export const ToolCreateRequest$inboundSchema: z.ZodType<
+  ToolCreateRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  name: z.string(),
+  definition: ToolDefinition$inboundSchema,
+  service_id: z.number().int(),
+}).transform((v) => {
+  return remap$(v, {
+    "service_id": "serviceId",
+  });
+});
+
+/** @internal */
+export type ToolCreateRequest$Outbound = {
+  name: string;
+  definition: ToolDefinition$Outbound;
+  service_id: number;
+};
+
+/** @internal */
+export const ToolCreateRequest$outboundSchema: z.ZodType<
+  ToolCreateRequest$Outbound,
+  z.ZodTypeDef,
+  ToolCreateRequest
+> = z.object({
+  name: z.string(),
+  definition: ToolDefinition$outboundSchema,
+  serviceId: z.number().int(),
+}).transform((v) => {
+  return remap$(v, {
+    serviceId: "service_id",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace ToolCreateRequest$ {
+  /** @deprecated use `ToolCreateRequest$inboundSchema` instead. */
+  export const inboundSchema = ToolCreateRequest$inboundSchema;
+  /** @deprecated use `ToolCreateRequest$outboundSchema` instead. */
+  export const outboundSchema = ToolCreateRequest$outboundSchema;
+  /** @deprecated use `ToolCreateRequest$Outbound` instead. */
+  export type Outbound = ToolCreateRequest$Outbound;
+}
+
+export function toolCreateRequestToJSON(
+  toolCreateRequest: ToolCreateRequest,
+): string {
+  return JSON.stringify(
+    ToolCreateRequest$outboundSchema.parse(toolCreateRequest),
+  );
+}
+
+export function toolCreateRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<ToolCreateRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ToolCreateRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ToolCreateRequest' from JSON`,
+  );
+}

package/src/models/components/tooldefinition.ts

@@ -0,0 +1,386 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { safeParse } from "../../lib/schemas.js";
+import { ClosedEnum } from "../../types/enums.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  InternalTool,
+  InternalTool$inboundSchema,
+  InternalTool$Outbound,
+  InternalTool$outboundSchema,
+} from "./internaltool.js";
+import {
+  ToolHttpEndpoint,
+  ToolHttpEndpoint$inboundSchema,
+  ToolHttpEndpoint$Outbound,
+  ToolHttpEndpoint$outboundSchema,
+} from "./toolhttpendpoint.js";
+import {
+  ToolParameterDefault,
+  ToolParameterDefault$inboundSchema,
+  ToolParameterDefault$Outbound,
+  ToolParameterDefault$outboundSchema,
+} from "./toolparameterdefault.js";
+
+export const Type = {
+  Action: "action",
+  Endpoint: "endpoint",
+  Context: "context",
+  Log: "log",
+} 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 an LLM during the conversation.
+ *
+ * @remarks
+ *
+ * The tool can result in one of the following actions depending on the `type` field:
+ * - `action`:
+ *   A request to perform an action.
+ * - `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 the LLM 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"
+ *     }
+ *   }
+ * }
+ *
+ * Using a value from another parameter and converting it to a dictionary:
+ * "defaults": {
+ *   "tags.hospital": "{vars.hospital}",
+ *   "tags.foo": "{params.foo}",
+ *   "foo": {
+ *     "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}"
+ *       }
+ *     }
+ *   }
+ * }
+ *
+ * Some common transform actions can be abbreviated using the `@` prefix to support a string syntax:
+ * "defaults": {
+ *   "foo": "@remove",
+ *   "name": "@override Hello, {name}!"
+ * }
+ */
+export type ToolDefinition = {
+  /**
+   * The action to take when the LLM calls the tool.
+   */
+  type?: Type | null | undefined;
+  /**
+   * A tool definition to be used by the OpenAI API.
+   */
+  tool: InternalTool;
+  /**
+   * The configuration for an HTTP API call.
+   */
+  endpoint?: ToolHttpEndpoint | 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;
+}
+
+export function oneToJSON(one: One): string {
+  return JSON.stringify(One$outboundSchema.parse(one));
+}
+
+export function oneFromJSON(
+  jsonString: string,
+): SafeParseResult<One, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => One$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'One' from JSON`,
+  );
+}
+
+/** @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;
+}
+
+export function defaultsToJSON(defaults: Defaults): string {
+  return JSON.stringify(Defaults$outboundSchema.parse(defaults));
+}
+
+export function defaultsFromJSON(
+  jsonString: string,
+): SafeParseResult<Defaults, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Defaults$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Defaults' from JSON`,
+  );
+}
+
+/** @internal */
+export const Result$inboundSchema: z.ZodType<Result, z.ZodTypeDef, unknown> = z
+  .object({});
+
+/** @internal */
+export type Result$Outbound = {};
+
+/** @internal */
+export const Result$outboundSchema: z.ZodType<
+  Result$Outbound,
+  z.ZodTypeDef,
+  Result
+> = 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 Result$ {
+  /** @deprecated use `Result$inboundSchema` instead. */
+  export const inboundSchema = Result$inboundSchema;
+  /** @deprecated use `Result$outboundSchema` instead. */
+  export const outboundSchema = Result$outboundSchema;
+  /** @deprecated use `Result$Outbound` instead. */
+  export type Outbound = Result$Outbound;
+}
+
+export function resultToJSON(result: Result): string {
+  return JSON.stringify(Result$outboundSchema.parse(result));
+}
+
+export function resultFromJSON(
+  jsonString: string,
+): SafeParseResult<Result, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Result$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Result' from JSON`,
+  );
+}
+
+/** @internal */
+export const ToolDefinition$inboundSchema: z.ZodType<
+  ToolDefinition,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  type: z.nullable(Type$inboundSchema).optional(),
+  tool: InternalTool$inboundSchema,
+  endpoint: z.nullable(ToolHttpEndpoint$inboundSchema).optional(),
+  defaults: z.nullable(
+    z.union([
+      z.lazy(() => One$inboundSchema),
+      z.record(ToolParameterDefault$inboundSchema),
+    ]),
+  ).optional(),
+  result: z.nullable(z.lazy(() => Result$inboundSchema)).optional(),
+});
+
+/** @internal */
+export type ToolDefinition$Outbound = {
+  type?: string | null | undefined;
+  tool: InternalTool$Outbound;
+  endpoint?: ToolHttpEndpoint$Outbound | null | undefined;
+  defaults?:
+    | One$Outbound
+    | { [k: string]: ToolParameterDefault$Outbound }
+    | null
+    | undefined;
+  result?: Result$Outbound | null | undefined;
+};
+
+/** @internal */
+export const ToolDefinition$outboundSchema: z.ZodType<
+  ToolDefinition$Outbound,
+  z.ZodTypeDef,
+  ToolDefinition
+> = z.object({
+  type: z.nullable(Type$outboundSchema).optional(),
+  tool: InternalTool$outboundSchema,
+  endpoint: z.nullable(ToolHttpEndpoint$outboundSchema).optional(),
+  defaults: z.nullable(
+    z.union([
+      z.lazy(() => One$outboundSchema),
+      z.record(ToolParameterDefault$outboundSchema),
+    ]),
+  ).optional(),
+  result: z.nullable(z.lazy(() => Result$outboundSchema)).optional(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace ToolDefinition$ {
+  /** @deprecated use `ToolDefinition$inboundSchema` instead. */
+  export const inboundSchema = ToolDefinition$inboundSchema;
+  /** @deprecated use `ToolDefinition$outboundSchema` instead. */
+  export const outboundSchema = ToolDefinition$outboundSchema;
+  /** @deprecated use `ToolDefinition$Outbound` instead. */
+  export type Outbound = ToolDefinition$Outbound;
+}
+
+export function toolDefinitionToJSON(toolDefinition: ToolDefinition): string {
+  return JSON.stringify(ToolDefinition$outboundSchema.parse(toolDefinition));
+}
+
+export function toolDefinitionFromJSON(
+  jsonString: string,
+): SafeParseResult<ToolDefinition, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ToolDefinition$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ToolDefinition' from JSON`,
+  );
+}

package/src/models/components/tooldetailresponse.ts

@@ -3,8 +3,12 @@
  */
 
 import * as z from "zod";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 export type ToolDetailResponse = {
+  id: number;
   name: string;
   description: string;
   fields: Array<string>;
@@ -16,6 +20,7 @@ export const ToolDetailResponse$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
+  id: z.number().int(),
   name: z.string(),
   description: z.string(),
   fields: z.array(z.string()),
@@ -23,6 +28,7 @@ export const ToolDetailResponse$inboundSchema: z.ZodType<
 
 /** @internal */
 export type ToolDetailResponse$Outbound = {
+  id: number;
   name: string;
   description: string;
   fields: Array<string>;
@@ -34,6 +40,7 @@ export const ToolDetailResponse$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   ToolDetailResponse
 > = z.object({
+  id: z.number().int(),
   name: z.string(),
   description: z.string(),
   fields: z.array(z.string()),
@@ -51,3 +58,21 @@ export namespace ToolDetailResponse$ {
   /** @deprecated use `ToolDetailResponse$Outbound` instead. */
   export type Outbound = ToolDetailResponse$Outbound;
 }
+
+export function toolDetailResponseToJSON(
+  toolDetailResponse: ToolDetailResponse,
+): string {
+  return JSON.stringify(
+    ToolDetailResponse$outboundSchema.parse(toolDetailResponse),
+  );
+}
+
+export function toolDetailResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<ToolDetailResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ToolDetailResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ToolDetailResponse' from JSON`,
+  );
+}