syllable-sdk 0.1.0-alpha.4 → 0.1.0-alpha.41

package/src/models/components/toolfunction.ts

@@ -0,0 +1,87 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+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";
+
+/**
+ * A function available to an agent.
+ *
+ * @remarks
+ *
+ * See:
+ * - https://learn.microsoft.com/en-us/azure/ai-services/openai/how-to/function-calling
+ */
+export type ToolFunction = {
+  /**
+   * The name of the function/tool call.
+   */
+  name: string;
+  /**
+   * The description of the tool.
+   */
+  description: string;
+  /**
+   * The JSON Schema of parameters of the function/tool call.
+   */
+  parameters?: any | undefined;
+};
+
+/** @internal */
+export const ToolFunction$inboundSchema: z.ZodType<
+  ToolFunction,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  name: z.string(),
+  description: z.string(),
+  parameters: z.any().optional(),
+});
+
+/** @internal */
+export type ToolFunction$Outbound = {
+  name: string;
+  description: string;
+  parameters?: any | undefined;
+};
+
+/** @internal */
+export const ToolFunction$outboundSchema: z.ZodType<
+  ToolFunction$Outbound,
+  z.ZodTypeDef,
+  ToolFunction
+> = z.object({
+  name: z.string(),
+  description: z.string(),
+  parameters: z.any().optional(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace ToolFunction$ {
+  /** @deprecated use `ToolFunction$inboundSchema` instead. */
+  export const inboundSchema = ToolFunction$inboundSchema;
+  /** @deprecated use `ToolFunction$outboundSchema` instead. */
+  export const outboundSchema = ToolFunction$outboundSchema;
+  /** @deprecated use `ToolFunction$Outbound` instead. */
+  export type Outbound = ToolFunction$Outbound;
+}
+
+export function toolFunctionToJSON(toolFunction: ToolFunction): string {
+  return JSON.stringify(ToolFunction$outboundSchema.parse(toolFunction));
+}
+
+export function toolFunctionFromJSON(
+  jsonString: string,
+): SafeParseResult<ToolFunction, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ToolFunction$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ToolFunction' from JSON`,
+  );
+}

package/src/models/components/toolhttpendpoint.ts

@@ -0,0 +1,111 @@
+/*
+ * 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 {
+  ToolArgumentLocation,
+  ToolArgumentLocation$inboundSchema,
+  ToolArgumentLocation$outboundSchema,
+} from "./toolargumentlocation.js";
+import {
+  ToolHttpMethod,
+  ToolHttpMethod$inboundSchema,
+  ToolHttpMethod$outboundSchema,
+} from "./toolhttpmethod.js";
+
+/**
+ * The configuration for an HTTP API call by a tool.
+ */
+export type ToolHttpEndpoint = {
+  /**
+   * The endpoint URL of the external service to call.
+   */
+  url: string;
+  /**
+   * The HTTP method to use for a tool HTTP request.
+   */
+  method: ToolHttpMethod;
+  /**
+   * The location of the argument in a tool HTTP request.
+   *
+   * @remarks
+   * 'body' is used for JSON data in the POST request body.
+   * 'form' is used for form data in the POST request body.
+   * 'path' is used for URL path parameters.
+   * 'query' is used for query parameters in the URL.
+   */
+  argumentLocation: ToolArgumentLocation;
+};
+
+/** @internal */
+export const ToolHttpEndpoint$inboundSchema: z.ZodType<
+  ToolHttpEndpoint,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  url: z.string(),
+  method: ToolHttpMethod$inboundSchema,
+  argument_location: ToolArgumentLocation$inboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    "argument_location": "argumentLocation",
+  });
+});
+
+/** @internal */
+export type ToolHttpEndpoint$Outbound = {
+  url: string;
+  method: string;
+  argument_location: string;
+};
+
+/** @internal */
+export const ToolHttpEndpoint$outboundSchema: z.ZodType<
+  ToolHttpEndpoint$Outbound,
+  z.ZodTypeDef,
+  ToolHttpEndpoint
+> = z.object({
+  url: z.string(),
+  method: ToolHttpMethod$outboundSchema,
+  argumentLocation: ToolArgumentLocation$outboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    argumentLocation: "argument_location",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace ToolHttpEndpoint$ {
+  /** @deprecated use `ToolHttpEndpoint$inboundSchema` instead. */
+  export const inboundSchema = ToolHttpEndpoint$inboundSchema;
+  /** @deprecated use `ToolHttpEndpoint$outboundSchema` instead. */
+  export const outboundSchema = ToolHttpEndpoint$outboundSchema;
+  /** @deprecated use `ToolHttpEndpoint$Outbound` instead. */
+  export type Outbound = ToolHttpEndpoint$Outbound;
+}
+
+export function toolHttpEndpointToJSON(
+  toolHttpEndpoint: ToolHttpEndpoint,
+): string {
+  return JSON.stringify(
+    ToolHttpEndpoint$outboundSchema.parse(toolHttpEndpoint),
+  );
+}
+
+export function toolHttpEndpointFromJSON(
+  jsonString: string,
+): SafeParseResult<ToolHttpEndpoint, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ToolHttpEndpoint$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ToolHttpEndpoint' from JSON`,
+  );
+}

package/src/models/components/toolhttpmethod.ts

@@ -0,0 +1,39 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { ClosedEnum } from "../../types/enums.js";
+
+/**
+ * The HTTP method to use for a tool HTTP request.
+ */
+export const ToolHttpMethod = {
+  Get: "get",
+  Post: "post",
+} as const;
+/**
+ * The HTTP method to use for a tool HTTP request.
+ */
+export type ToolHttpMethod = ClosedEnum<typeof ToolHttpMethod>;
+
+/** @internal */
+export const ToolHttpMethod$inboundSchema: z.ZodNativeEnum<
+  typeof ToolHttpMethod
+> = z.nativeEnum(ToolHttpMethod);
+
+/** @internal */
+export const ToolHttpMethod$outboundSchema: z.ZodNativeEnum<
+  typeof ToolHttpMethod
+> = ToolHttpMethod$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace ToolHttpMethod$ {
+  /** @deprecated use `ToolHttpMethod$inboundSchema` instead. */
+  export const inboundSchema = ToolHttpMethod$inboundSchema;
+  /** @deprecated use `ToolHttpMethod$outboundSchema` instead. */
+  export const outboundSchema = ToolHttpMethod$outboundSchema;
+}

package/src/models/components/toolparameterdefault.ts

@@ -0,0 +1,84 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+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";
+import {
+  ToolParameterTransform,
+  ToolParameterTransform$inboundSchema,
+  ToolParameterTransform$Outbound,
+  ToolParameterTransform$outboundSchema,
+} from "./toolparametertransform.js";
+
+/**
+ * The default value for a parameter of a tool call.
+ */
+export type ToolParameterDefault = {
+  /**
+   * A transform to be applied to the value of a tool parameter.
+   *
+   * @remarks
+   *
+   * Either `value` or `format` must be set:
+   * - `value` is any arbitrary value: string, list or dictionary.
+   * - `format` is a string composed of other parameters or context variables.
+   */
+  transform: ToolParameterTransform;
+};
+
+/** @internal */
+export const ToolParameterDefault$inboundSchema: z.ZodType<
+  ToolParameterDefault,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  transform: ToolParameterTransform$inboundSchema,
+});
+
+/** @internal */
+export type ToolParameterDefault$Outbound = {
+  transform: ToolParameterTransform$Outbound;
+};
+
+/** @internal */
+export const ToolParameterDefault$outboundSchema: z.ZodType<
+  ToolParameterDefault$Outbound,
+  z.ZodTypeDef,
+  ToolParameterDefault
+> = z.object({
+  transform: ToolParameterTransform$outboundSchema,
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace ToolParameterDefault$ {
+  /** @deprecated use `ToolParameterDefault$inboundSchema` instead. */
+  export const inboundSchema = ToolParameterDefault$inboundSchema;
+  /** @deprecated use `ToolParameterDefault$outboundSchema` instead. */
+  export const outboundSchema = ToolParameterDefault$outboundSchema;
+  /** @deprecated use `ToolParameterDefault$Outbound` instead. */
+  export type Outbound = ToolParameterDefault$Outbound;
+}
+
+export function toolParameterDefaultToJSON(
+  toolParameterDefault: ToolParameterDefault,
+): string {
+  return JSON.stringify(
+    ToolParameterDefault$outboundSchema.parse(toolParameterDefault),
+  );
+}
+
+export function toolParameterDefaultFromJSON(
+  jsonString: string,
+): SafeParseResult<ToolParameterDefault, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ToolParameterDefault$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ToolParameterDefault' from JSON`,
+  );
+}

package/src/models/components/toolparametertransform.ts

@@ -0,0 +1,138 @@
+/*
+ * 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 {
+  ToolParameterTransformCondition,
+  ToolParameterTransformCondition$inboundSchema,
+  ToolParameterTransformCondition$Outbound,
+  ToolParameterTransformCondition$outboundSchema,
+} from "./toolparametertransformcondition.js";
+
+/**
+ * The action to perform on the tool parameter 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 tool parameter 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 tool parameter.
+ *
+ * @remarks
+ *
+ * Either `value` or `format` must be set:
+ * - `value` is any arbitrary value: string, list or dictionary.
+ * - `format` is a string composed of other parameters or context variables.
+ */
+export type ToolParameterTransform = {
+  /**
+   * The action to perform on the tool parameter 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?: Action | undefined;
+  /**
+   * Only apply the transform if the condition is met.
+   */
+  when?: ToolParameterTransformCondition | null | undefined;
+  /**
+   * The default value to use for the parameter.
+   */
+  value?: any | null | 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,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  action: Action$inboundSchema.default("default"),
+  when: z.nullable(ToolParameterTransformCondition$inboundSchema).optional(),
+  value: z.nullable(z.any()).optional(),
+  format: z.nullable(z.string()).optional(),
+});
+
+/** @internal */
+export type ToolParameterTransform$Outbound = {
+  action: string;
+  when?: ToolParameterTransformCondition$Outbound | null | undefined;
+  value?: any | null | undefined;
+  format?: string | null | undefined;
+};
+
+/** @internal */
+export const ToolParameterTransform$outboundSchema: z.ZodType<
+  ToolParameterTransform$Outbound,
+  z.ZodTypeDef,
+  ToolParameterTransform
+> = z.object({
+  action: Action$outboundSchema.default("default"),
+  when: z.nullable(ToolParameterTransformCondition$outboundSchema).optional(),
+  value: z.nullable(z.any()).optional(),
+  format: z.nullable(z.string()).optional(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace ToolParameterTransform$ {
+  /** @deprecated use `ToolParameterTransform$inboundSchema` instead. */
+  export const inboundSchema = ToolParameterTransform$inboundSchema;
+  /** @deprecated use `ToolParameterTransform$outboundSchema` instead. */
+  export const outboundSchema = ToolParameterTransform$outboundSchema;
+  /** @deprecated use `ToolParameterTransform$Outbound` instead. */
+  export type Outbound = ToolParameterTransform$Outbound;
+}
+
+export function toolParameterTransformToJSON(
+  toolParameterTransform: ToolParameterTransform,
+): string {
+  return JSON.stringify(
+    ToolParameterTransform$outboundSchema.parse(toolParameterTransform),
+  );
+}
+
+export function toolParameterTransformFromJSON(
+  jsonString: string,
+): SafeParseResult<ToolParameterTransform, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ToolParameterTransform$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ToolParameterTransform' from JSON`,
+  );
+}

package/src/models/components/toolparametertransformcondition.ts

@@ -0,0 +1,88 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+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";
+
+/**
+ * A condition to be met for a transform to be applied to the value of a tool parameter.
+ */
+export type ToolParameterTransformCondition = {
+  /**
+   * The name of the parameter to check.
+   */
+  key: string;
+  /**
+   * The value to check against the parameter.
+   */
+  value: string;
+  /**
+   * The operator to use for the comparison.
+   */
+  operator?: "eq" | null | undefined;
+};
+
+/** @internal */
+export const ToolParameterTransformCondition$inboundSchema: z.ZodType<
+  ToolParameterTransformCondition,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  key: z.string(),
+  value: z.string(),
+  operator: z.nullable(z.literal("eq")).optional(),
+});
+
+/** @internal */
+export type ToolParameterTransformCondition$Outbound = {
+  key: string;
+  value: string;
+  operator: "eq" | null;
+};
+
+/** @internal */
+export const ToolParameterTransformCondition$outboundSchema: z.ZodType<
+  ToolParameterTransformCondition$Outbound,
+  z.ZodTypeDef,
+  ToolParameterTransformCondition
+> = z.object({
+  key: z.string(),
+  value: z.string(),
+  operator: z.nullable(z.literal("eq").default("eq" as const)),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace ToolParameterTransformCondition$ {
+  /** @deprecated use `ToolParameterTransformCondition$inboundSchema` instead. */
+  export const inboundSchema = ToolParameterTransformCondition$inboundSchema;
+  /** @deprecated use `ToolParameterTransformCondition$outboundSchema` instead. */
+  export const outboundSchema = ToolParameterTransformCondition$outboundSchema;
+  /** @deprecated use `ToolParameterTransformCondition$Outbound` instead. */
+  export type Outbound = ToolParameterTransformCondition$Outbound;
+}
+
+export function toolParameterTransformConditionToJSON(
+  toolParameterTransformCondition: ToolParameterTransformCondition,
+): string {
+  return JSON.stringify(
+    ToolParameterTransformCondition$outboundSchema.parse(
+      toolParameterTransformCondition,
+    ),
+  );
+}
+
+export function toolParameterTransformConditionFromJSON(
+  jsonString: string,
+): SafeParseResult<ToolParameterTransformCondition, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ToolParameterTransformCondition$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ToolParameterTransformCondition' from JSON`,
+  );
+}

package/src/models/components/toolproperties.ts

@@ -11,6 +11,8 @@ export const ToolProperties = {
   ServiceName: "service_name",
   Definition: "definition",
   ServiceId: "service_id",
+  UpdatedAt: "updated_at",
+  LastUpdatedBy: "last_updated_by",
 } as const;
 export type ToolProperties = ClosedEnum<typeof ToolProperties>;
 

package/src/models/components/toolresponse.ts

@@ -0,0 +1,146 @@
+/*
+ * 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";
+
+/**
+ * A tool is a function that an agent can call to perform actions like accessing databases,
+ *
+ * @remarks
+ * making API calls, or processing data. For an agent to have access to a tool, the prompt
+ * associated with that agent should be linked to the tool and include instructions to use it.
+ */
+export type ToolResponse = {
+  /**
+   * The name of the tool
+   */
+  name: string;
+  /**
+   * A tool that can be called from an LLM during the conversation.
+   */
+  definition: ToolDefinition;
+  /**
+   * The service to which this tool belongs
+   */
+  serviceId: number;
+  /**
+   * The ID of the tool
+   */
+  id: number;
+  /**
+   * Update comments
+   */
+  lastUpdatedComments?: string | null | undefined;
+  /**
+   * The name of the service to which the tool belongs
+   */
+  serviceName?: string | null | undefined;
+  /**
+   * The timestamp of the most recent update to the service
+   */
+  lastUpdated: Date;
+  /**
+   * The email of the user who last updated the tool
+   */
+  lastUpdatedBy: string;
+};
+
+/** @internal */
+export const ToolResponse$inboundSchema: z.ZodType<
+  ToolResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  name: z.string(),
+  definition: ToolDefinition$inboundSchema,
+  service_id: z.number().int(),
+  id: z.number().int(),
+  last_updated_comments: z.nullable(z.string()).optional(),
+  service_name: z.nullable(z.string()).optional(),
+  last_updated: z.string().datetime({ offset: true }).transform(v =>
+    new Date(v)
+  ),
+  last_updated_by: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    "service_id": "serviceId",
+    "last_updated_comments": "lastUpdatedComments",
+    "service_name": "serviceName",
+    "last_updated": "lastUpdated",
+    "last_updated_by": "lastUpdatedBy",
+  });
+});
+
+/** @internal */
+export type ToolResponse$Outbound = {
+  name: string;
+  definition: ToolDefinition$Outbound;
+  service_id: number;
+  id: number;
+  last_updated_comments?: string | null | undefined;
+  service_name?: string | null | undefined;
+  last_updated: string;
+  last_updated_by: string;
+};
+
+/** @internal */
+export const ToolResponse$outboundSchema: z.ZodType<
+  ToolResponse$Outbound,
+  z.ZodTypeDef,
+  ToolResponse
+> = z.object({
+  name: z.string(),
+  definition: ToolDefinition$outboundSchema,
+  serviceId: z.number().int(),
+  id: z.number().int(),
+  lastUpdatedComments: z.nullable(z.string()).optional(),
+  serviceName: z.nullable(z.string()).optional(),
+  lastUpdated: z.date().transform(v => v.toISOString()),
+  lastUpdatedBy: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    serviceId: "service_id",
+    lastUpdatedComments: "last_updated_comments",
+    serviceName: "service_name",
+    lastUpdated: "last_updated",
+    lastUpdatedBy: "last_updated_by",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace ToolResponse$ {
+  /** @deprecated use `ToolResponse$inboundSchema` instead. */
+  export const inboundSchema = ToolResponse$inboundSchema;
+  /** @deprecated use `ToolResponse$outboundSchema` instead. */
+  export const outboundSchema = ToolResponse$outboundSchema;
+  /** @deprecated use `ToolResponse$Outbound` instead. */
+  export type Outbound = ToolResponse$Outbound;
+}
+
+export function toolResponseToJSON(toolResponse: ToolResponse): string {
+  return JSON.stringify(ToolResponse$outboundSchema.parse(toolResponse));
+}
+
+export function toolResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<ToolResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ToolResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ToolResponse' from JSON`,
+  );
+}