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

package/models/components/{function.d.ts → toolfunction.d.ts}

@@ -6,14 +6,14 @@ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
  */
 export type ParametersT = {};
 /**
- * A tool definition to be used by the OpenAI API.
+ * A function available to an agent.
  *
  * @remarks
  *
  * See:
  * - https://learn.microsoft.com/en-us/azure/ai-services/openai/how-to/function-calling
  */
-export type FunctionT = {
+export type ToolFunction = {
     /**
      * The name of the function/tool call.
      */
@@ -48,27 +48,27 @@ export declare namespace ParametersT$ {
 export declare function parametersToJSON(parametersT: ParametersT): string;
 export declare function parametersFromJSON(jsonString: string): SafeParseResult<ParametersT, SDKValidationError>;
 /** @internal */
-export declare const FunctionT$inboundSchema: z.ZodType<FunctionT, z.ZodTypeDef, unknown>;
+export declare const ToolFunction$inboundSchema: z.ZodType<ToolFunction, z.ZodTypeDef, unknown>;
 /** @internal */
-export type FunctionT$Outbound = {
+export type ToolFunction$Outbound = {
     name: string;
     description: string;
     parameters: ParametersT$Outbound;
 };
 /** @internal */
-export declare const FunctionT$outboundSchema: z.ZodType<FunctionT$Outbound, z.ZodTypeDef, FunctionT>;
+export declare const ToolFunction$outboundSchema: z.ZodType<ToolFunction$Outbound, z.ZodTypeDef, ToolFunction>;
 /**
  * @internal
  * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
  */
-export declare namespace FunctionT$ {
-    /** @deprecated use `FunctionT$inboundSchema` instead. */
-    const inboundSchema: z.ZodType<FunctionT, z.ZodTypeDef, unknown>;
-    /** @deprecated use `FunctionT$outboundSchema` instead. */
-    const outboundSchema: z.ZodType<FunctionT$Outbound, z.ZodTypeDef, FunctionT>;
-    /** @deprecated use `FunctionT$Outbound` instead. */
-    type Outbound = FunctionT$Outbound;
+export declare namespace ToolFunction$ {
+    /** @deprecated use `ToolFunction$inboundSchema` instead. */
+    const inboundSchema: z.ZodType<ToolFunction, z.ZodTypeDef, unknown>;
+    /** @deprecated use `ToolFunction$outboundSchema` instead. */
+    const outboundSchema: z.ZodType<ToolFunction$Outbound, z.ZodTypeDef, ToolFunction>;
+    /** @deprecated use `ToolFunction$Outbound` instead. */
+    type Outbound = ToolFunction$Outbound;
 }
-export declare function functionToJSON(functionT: FunctionT): string;
-export declare function functionFromJSON(jsonString: string): SafeParseResult<FunctionT, SDKValidationError>;
-//# sourceMappingURL=function.d.ts.map
+export declare function toolFunctionToJSON(toolFunction: ToolFunction): string;
+export declare function toolFunctionFromJSON(jsonString: string): SafeParseResult<ToolFunction, SDKValidationError>;
+//# sourceMappingURL=toolfunction.d.ts.map

package/models/components/toolfunction.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"toolfunction.d.ts","sourceRoot":"","sources":["../../src/models/components/toolfunction.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAC;AAEzB,OAAO,EAAE,MAAM,IAAI,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAC9D,OAAO,EAAE,kBAAkB,EAAE,MAAM,iCAAiC,CAAC;AAErE;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG,EAAE,CAAC;AAE7B;;;;;;;GAOG;AACH,MAAM,MAAM,YAAY,GAAG;IACzB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,UAAU,EAAE,WAAW,CAAC;CACzB,CAAC;AAEF,gBAAgB;AAChB,eAAO,MAAM,yBAAyB,EAAE,CAAC,CAAC,OAAO,CAC/C,WAAW,EACX,CAAC,CAAC,UAAU,EACZ,OAAO,CACO,CAAC;AAEjB,gBAAgB;AAChB,MAAM,MAAM,oBAAoB,GAAG,EAAE,CAAC;AAEtC,gBAAgB;AAChB,eAAO,MAAM,0BAA0B,EAAE,CAAC,CAAC,OAAO,CAChD,oBAAoB,EACpB,CAAC,CAAC,UAAU,EACZ,WAAW,CACG,CAAC;AAEjB;;;GAGG;AACH,yBAAiB,YAAY,CAAC;IAC5B,2DAA2D;IACpD,MAAM,aAAa,+CAA4B,CAAC;IACvD,4DAA4D;IACrD,MAAM,cAAc,4DAA6B,CAAC;IACzD,sDAAsD;IACtD,KAAY,QAAQ,GAAG,oBAAoB,CAAC;CAC7C;AAED,wBAAgB,gBAAgB,CAAC,WAAW,EAAE,WAAW,GAAG,MAAM,CAEjE;AAED,wBAAgB,kBAAkB,CAChC,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,WAAW,EAAE,kBAAkB,CAAC,CAMlD;AAED,gBAAgB;AAChB,eAAO,MAAM,0BAA0B,EAAE,CAAC,CAAC,OAAO,CAChD,YAAY,EACZ,CAAC,CAAC,UAAU,EACZ,OAAO,CAKP,CAAC;AAEH,gBAAgB;AAChB,MAAM,MAAM,qBAAqB,GAAG;IAClC,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;IACpB,UAAU,EAAE,oBAAoB,CAAC;CAClC,CAAC;AAEF,gBAAgB;AAChB,eAAO,MAAM,2BAA2B,EAAE,CAAC,CAAC,OAAO,CACjD,qBAAqB,EACrB,CAAC,CAAC,UAAU,EACZ,YAAY,CAKZ,CAAC;AAEH;;;GAGG;AACH,yBAAiB,aAAa,CAAC;IAC7B,4DAA4D;IACrD,MAAM,aAAa,gDAA6B,CAAC;IACxD,6DAA6D;IACtD,MAAM,cAAc,8DAA8B,CAAC;IAC1D,uDAAuD;IACvD,KAAY,QAAQ,GAAG,qBAAqB,CAAC;CAC9C;AAED,wBAAgB,kBAAkB,CAAC,YAAY,EAAE,YAAY,GAAG,MAAM,CAErE;AAED,wBAAgB,oBAAoB,CAClC,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,YAAY,EAAE,kBAAkB,CAAC,CAMnD"}

package/models/components/{function.js → toolfunction.js}

@@ -26,11 +26,11 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.FunctionT$ = exports.FunctionT$outboundSchema = exports.FunctionT$inboundSchema = exports.ParametersT$ = exports.ParametersT$outboundSchema = exports.ParametersT$inboundSchema = void 0;
+exports.ToolFunction$ = exports.ToolFunction$outboundSchema = exports.ToolFunction$inboundSchema = exports.ParametersT$ = exports.ParametersT$outboundSchema = exports.ParametersT$inboundSchema = void 0;
 exports.parametersToJSON = parametersToJSON;
 exports.parametersFromJSON = parametersFromJSON;
-exports.functionToJSON = functionToJSON;
-exports.functionFromJSON = functionFromJSON;
+exports.toolFunctionToJSON = toolFunctionToJSON;
+exports.toolFunctionFromJSON = toolFunctionFromJSON;
 const z = __importStar(require("zod"));
 const schemas_js_1 = require("../../lib/schemas.js");
 /** @internal */
@@ -55,13 +55,13 @@ function parametersFromJSON(jsonString) {
     return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ParametersT$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ParametersT' from JSON`);
 }
 /** @internal */
-exports.FunctionT$inboundSchema = z.object({
+exports.ToolFunction$inboundSchema = z.object({
     name: z.string(),
     description: z.string(),
     parameters: z.lazy(() => exports.ParametersT$inboundSchema),
 });
 /** @internal */
-exports.FunctionT$outboundSchema = z.object({
+exports.ToolFunction$outboundSchema = z.object({
     name: z.string(),
     description: z.string(),
     parameters: z.lazy(() => exports.ParametersT$outboundSchema),
@@ -70,17 +70,17 @@ exports.FunctionT$outboundSchema = z.object({
  * @internal
  * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
  */
-var FunctionT$;
-(function (FunctionT$) {
-    /** @deprecated use `FunctionT$inboundSchema` instead. */
-    FunctionT$.inboundSchema = exports.FunctionT$inboundSchema;
-    /** @deprecated use `FunctionT$outboundSchema` instead. */
-    FunctionT$.outboundSchema = exports.FunctionT$outboundSchema;
-})(FunctionT$ || (exports.FunctionT$ = FunctionT$ = {}));
-function functionToJSON(functionT) {
-    return JSON.stringify(exports.FunctionT$outboundSchema.parse(functionT));
+var ToolFunction$;
+(function (ToolFunction$) {
+    /** @deprecated use `ToolFunction$inboundSchema` instead. */
+    ToolFunction$.inboundSchema = exports.ToolFunction$inboundSchema;
+    /** @deprecated use `ToolFunction$outboundSchema` instead. */
+    ToolFunction$.outboundSchema = exports.ToolFunction$outboundSchema;
+})(ToolFunction$ || (exports.ToolFunction$ = ToolFunction$ = {}));
+function toolFunctionToJSON(toolFunction) {
+    return JSON.stringify(exports.ToolFunction$outboundSchema.parse(toolFunction));
 }
-function functionFromJSON(jsonString) {
-    return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.FunctionT$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'FunctionT' from JSON`);
+function toolFunctionFromJSON(jsonString) {
+    return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ToolFunction$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ToolFunction' from JSON`);
 }
-//# sourceMappingURL=function.js.map
+//# sourceMappingURL=toolfunction.js.map

package/models/components/toolfunction.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"toolfunction.js","sourceRoot":"","sources":["../../src/models/components/toolfunction.ts"],"names":[],"mappings":";AAAA;;GAEG;;;;;;;;;;;;;;;;;;;;;;;;;;AAiEH,4CAEC;AAED,gDAQC;AA4CD,gDAEC;AAED,oDAQC;AAnID,uCAAyB;AACzB,qDAAiD;AAgCjD,gBAAgB;AACH,QAAA,yBAAyB,GAIlC,CAAC,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;AAKjB,gBAAgB;AACH,QAAA,0BAA0B,GAInC,CAAC,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;AAEjB;;;GAGG;AACH,IAAiB,YAAY,CAO5B;AAPD,WAAiB,YAAY;IAC3B,2DAA2D;IAC9C,0BAAa,GAAG,iCAAyB,CAAC;IACvD,4DAA4D;IAC/C,2BAAc,GAAG,kCAA0B,CAAC;AAG3D,CAAC,EAPgB,YAAY,4BAAZ,YAAY,QAO5B;AAED,SAAgB,gBAAgB,CAAC,WAAwB;IACvD,OAAO,IAAI,CAAC,SAAS,CAAC,kCAA0B,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC,CAAC;AACvE,CAAC;AAED,SAAgB,kBAAkB,CAChC,UAAkB;IAElB,OAAO,IAAA,sBAAS,EACd,UAAU,EACV,CAAC,CAAC,EAAE,EAAE,CAAC,iCAAyB,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EACrD,yCAAyC,CAC1C,CAAC;AACJ,CAAC;AAED,gBAAgB;AACH,QAAA,0BAA0B,GAInC,CAAC,CAAC,MAAM,CAAC;IACX,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;IAChB,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE;IACvB,UAAU,EAAE,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,iCAAyB,CAAC;CACpD,CAAC,CAAC;AASH,gBAAgB;AACH,QAAA,2BAA2B,GAIpC,CAAC,CAAC,MAAM,CAAC;IACX,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;IAChB,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE;IACvB,UAAU,EAAE,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,kCAA0B,CAAC;CACrD,CAAC,CAAC;AAEH;;;GAGG;AACH,IAAiB,aAAa,CAO7B;AAPD,WAAiB,aAAa;IAC5B,4DAA4D;IAC/C,2BAAa,GAAG,kCAA0B,CAAC;IACxD,6DAA6D;IAChD,4BAAc,GAAG,mCAA2B,CAAC;AAG5D,CAAC,EAPgB,aAAa,6BAAb,aAAa,QAO7B;AAED,SAAgB,kBAAkB,CAAC,YAA0B;IAC3D,OAAO,IAAI,CAAC,SAAS,CAAC,mCAA2B,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC,CAAC;AACzE,CAAC;AAED,SAAgB,oBAAoB,CAClC,UAAkB;IAElB,OAAO,IAAA,sBAAS,EACd,UAAU,EACV,CAAC,CAAC,EAAE,EAAE,CAAC,kCAA0B,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EACtD,0CAA0C,CAC3C,CAAC;AACJ,CAAC"}

package/models/components/toolhttpendpoint.d.ts

@@ -0,0 +1,53 @@
+import * as z from "zod";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import { ToolArgumentLocation } from "./toolargumentlocation.js";
+import { ToolHttpMethod } 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 declare const ToolHttpEndpoint$inboundSchema: z.ZodType<ToolHttpEndpoint, z.ZodTypeDef, unknown>;
+/** @internal */
+export type ToolHttpEndpoint$Outbound = {
+    url: string;
+    method: string;
+    argument_location: string;
+};
+/** @internal */
+export declare const ToolHttpEndpoint$outboundSchema: z.ZodType<ToolHttpEndpoint$Outbound, z.ZodTypeDef, ToolHttpEndpoint>;
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export declare namespace ToolHttpEndpoint$ {
+    /** @deprecated use `ToolHttpEndpoint$inboundSchema` instead. */
+    const inboundSchema: z.ZodType<ToolHttpEndpoint, z.ZodTypeDef, unknown>;
+    /** @deprecated use `ToolHttpEndpoint$outboundSchema` instead. */
+    const outboundSchema: z.ZodType<ToolHttpEndpoint$Outbound, z.ZodTypeDef, ToolHttpEndpoint>;
+    /** @deprecated use `ToolHttpEndpoint$Outbound` instead. */
+    type Outbound = ToolHttpEndpoint$Outbound;
+}
+export declare function toolHttpEndpointToJSON(toolHttpEndpoint: ToolHttpEndpoint): string;
+export declare function toolHttpEndpointFromJSON(jsonString: string): SafeParseResult<ToolHttpEndpoint, SDKValidationError>;
+//# sourceMappingURL=toolhttpendpoint.d.ts.map

package/models/components/toolhttpendpoint.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"toolhttpendpoint.d.ts","sourceRoot":"","sources":["../../src/models/components/toolhttpendpoint.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAC;AAGzB,OAAO,EAAE,MAAM,IAAI,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAC9D,OAAO,EAAE,kBAAkB,EAAE,MAAM,iCAAiC,CAAC;AACrE,OAAO,EACL,oBAAoB,EAGrB,MAAM,2BAA2B,CAAC;AACnC,OAAO,EACL,cAAc,EAGf,MAAM,qBAAqB,CAAC;AAE7B;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAC7B;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IACZ;;OAEG;IACH,MAAM,EAAE,cAAc,CAAC;IACvB;;;;;;;;OAQG;IACH,gBAAgB,EAAE,oBAAoB,CAAC;CACxC,CAAC;AAEF,gBAAgB;AAChB,eAAO,MAAM,8BAA8B,EAAE,CAAC,CAAC,OAAO,CACpD,gBAAgB,EAChB,CAAC,CAAC,UAAU,EACZ,OAAO,CASP,CAAC;AAEH,gBAAgB;AAChB,MAAM,MAAM,yBAAyB,GAAG;IACtC,GAAG,EAAE,MAAM,CAAC;IACZ,MAAM,EAAE,MAAM,CAAC;IACf,iBAAiB,EAAE,MAAM,CAAC;CAC3B,CAAC;AAEF,gBAAgB;AAChB,eAAO,MAAM,+BAA+B,EAAE,CAAC,CAAC,OAAO,CACrD,yBAAyB,EACzB,CAAC,CAAC,UAAU,EACZ,gBAAgB,CAShB,CAAC;AAEH;;;GAGG;AACH,yBAAiB,iBAAiB,CAAC;IACjC,gEAAgE;IACzD,MAAM,aAAa,oDAAiC,CAAC;IAC5D,iEAAiE;IAC1D,MAAM,cAAc,sEAAkC,CAAC;IAC9D,2DAA2D;IAC3D,KAAY,QAAQ,GAAG,yBAAyB,CAAC;CAClD;AAED,wBAAgB,sBAAsB,CACpC,gBAAgB,EAAE,gBAAgB,GACjC,MAAM,CAIR;AAED,wBAAgB,wBAAwB,CACtC,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,gBAAgB,EAAE,kBAAkB,CAAC,CAMvD"}

package/models/components/toolhttpendpoint.js

@@ -0,0 +1,74 @@
+"use strict";
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ToolHttpEndpoint$ = exports.ToolHttpEndpoint$outboundSchema = exports.ToolHttpEndpoint$inboundSchema = void 0;
+exports.toolHttpEndpointToJSON = toolHttpEndpointToJSON;
+exports.toolHttpEndpointFromJSON = toolHttpEndpointFromJSON;
+const z = __importStar(require("zod"));
+const primitives_js_1 = require("../../lib/primitives.js");
+const schemas_js_1 = require("../../lib/schemas.js");
+const toolargumentlocation_js_1 = require("./toolargumentlocation.js");
+const toolhttpmethod_js_1 = require("./toolhttpmethod.js");
+/** @internal */
+exports.ToolHttpEndpoint$inboundSchema = z.object({
+    url: z.string(),
+    method: toolhttpmethod_js_1.ToolHttpMethod$inboundSchema,
+    argument_location: toolargumentlocation_js_1.ToolArgumentLocation$inboundSchema,
+}).transform((v) => {
+    return (0, primitives_js_1.remap)(v, {
+        "argument_location": "argumentLocation",
+    });
+});
+/** @internal */
+exports.ToolHttpEndpoint$outboundSchema = z.object({
+    url: z.string(),
+    method: toolhttpmethod_js_1.ToolHttpMethod$outboundSchema,
+    argumentLocation: toolargumentlocation_js_1.ToolArgumentLocation$outboundSchema,
+}).transform((v) => {
+    return (0, primitives_js_1.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.
+ */
+var ToolHttpEndpoint$;
+(function (ToolHttpEndpoint$) {
+    /** @deprecated use `ToolHttpEndpoint$inboundSchema` instead. */
+    ToolHttpEndpoint$.inboundSchema = exports.ToolHttpEndpoint$inboundSchema;
+    /** @deprecated use `ToolHttpEndpoint$outboundSchema` instead. */
+    ToolHttpEndpoint$.outboundSchema = exports.ToolHttpEndpoint$outboundSchema;
+})(ToolHttpEndpoint$ || (exports.ToolHttpEndpoint$ = ToolHttpEndpoint$ = {}));
+function toolHttpEndpointToJSON(toolHttpEndpoint) {
+    return JSON.stringify(exports.ToolHttpEndpoint$outboundSchema.parse(toolHttpEndpoint));
+}
+function toolHttpEndpointFromJSON(jsonString) {
+    return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ToolHttpEndpoint$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ToolHttpEndpoint' from JSON`);
+}
+//# sourceMappingURL=toolhttpendpoint.js.map

package/models/components/toolhttpendpoint.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"toolhttpendpoint.js","sourceRoot":"","sources":["../../src/models/components/toolhttpendpoint.ts"],"names":[],"mappings":";AAAA;;GAEG;;;;;;;;;;;;;;;;;;;;;;;;;;AA4FH,wDAMC;AAED,4DAQC;AA1GD,uCAAyB;AACzB,2DAA0D;AAC1D,qDAAiD;AAGjD,uEAImC;AACnC,2DAI6B;AA0B7B,gBAAgB;AACH,QAAA,8BAA8B,GAIvC,CAAC,CAAC,MAAM,CAAC;IACX,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE;IACf,MAAM,EAAE,gDAA4B;IACpC,iBAAiB,EAAE,4DAAkC;CACtD,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE;IACjB,OAAO,IAAA,qBAAM,EAAC,CAAC,EAAE;QACf,mBAAmB,EAAE,kBAAkB;KACxC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AASH,gBAAgB;AACH,QAAA,+BAA+B,GAIxC,CAAC,CAAC,MAAM,CAAC;IACX,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE;IACf,MAAM,EAAE,iDAA6B;IACrC,gBAAgB,EAAE,6DAAmC;CACtD,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE;IACjB,OAAO,IAAA,qBAAM,EAAC,CAAC,EAAE;QACf,gBAAgB,EAAE,mBAAmB;KACtC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH;;;GAGG;AACH,IAAiB,iBAAiB,CAOjC;AAPD,WAAiB,iBAAiB;IAChC,gEAAgE;IACnD,+BAAa,GAAG,sCAA8B,CAAC;IAC5D,iEAAiE;IACpD,gCAAc,GAAG,uCAA+B,CAAC;AAGhE,CAAC,EAPgB,iBAAiB,iCAAjB,iBAAiB,QAOjC;AAED,SAAgB,sBAAsB,CACpC,gBAAkC;IAElC,OAAO,IAAI,CAAC,SAAS,CACnB,uCAA+B,CAAC,KAAK,CAAC,gBAAgB,CAAC,CACxD,CAAC;AACJ,CAAC;AAED,SAAgB,wBAAwB,CACtC,UAAkB;IAElB,OAAO,IAAA,sBAAS,EACd,UAAU,EACV,CAAC,CAAC,EAAE,EAAE,CAAC,sCAA8B,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAC1D,8CAA8C,CAC/C,CAAC;AACJ,CAAC"}

package/models/components/toolhttpmethod.d.ts

@@ -0,0 +1,34 @@
+import * as z from "zod";
+import { ClosedEnum } from "../../types/enums.js";
+/**
+ * The HTTP method to use for a tool HTTP request.
+ */
+export declare const ToolHttpMethod: {
+    readonly Get: "get";
+    readonly Post: "post";
+};
+/**
+ * The HTTP method to use for a tool HTTP request.
+ */
+export type ToolHttpMethod = ClosedEnum<typeof ToolHttpMethod>;
+/** @internal */
+export declare const ToolHttpMethod$inboundSchema: z.ZodNativeEnum<typeof ToolHttpMethod>;
+/** @internal */
+export declare const ToolHttpMethod$outboundSchema: z.ZodNativeEnum<typeof ToolHttpMethod>;
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export declare namespace ToolHttpMethod$ {
+    /** @deprecated use `ToolHttpMethod$inboundSchema` instead. */
+    const inboundSchema: z.ZodNativeEnum<{
+        readonly Get: "get";
+        readonly Post: "post";
+    }>;
+    /** @deprecated use `ToolHttpMethod$outboundSchema` instead. */
+    const outboundSchema: z.ZodNativeEnum<{
+        readonly Get: "get";
+        readonly Post: "post";
+    }>;
+}
+//# sourceMappingURL=toolhttpmethod.d.ts.map

package/models/components/toolhttpmethod.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"toolhttpmethod.d.ts","sourceRoot":"","sources":["../../src/models/components/toolhttpmethod.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAC;AACzB,OAAO,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAC;AAElD;;GAEG;AACH,eAAO,MAAM,cAAc;;;CAGjB,CAAC;AACX;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG,UAAU,CAAC,OAAO,cAAc,CAAC,CAAC;AAE/D,gBAAgB;AAChB,eAAO,MAAM,4BAA4B,EAAE,CAAC,CAAC,aAAa,CACxD,OAAO,cAAc,CACS,CAAC;AAEjC,gBAAgB;AAChB,eAAO,MAAM,6BAA6B,EAAE,CAAC,CAAC,aAAa,CACzD,OAAO,cAAc,CACS,CAAC;AAEjC;;;GAGG;AACH,yBAAiB,eAAe,CAAC;IAC/B,8DAA8D;IACvD,MAAM,aAAa;;;MAA+B,CAAC;IAC1D,+DAA+D;IACxD,MAAM,cAAc;;;MAAgC,CAAC;CAC7D"}

package/models/components/{directorymemberproperties.js → toolhttpmethod.js}

@@ -26,29 +26,28 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.DirectoryMemberProperties$ = exports.DirectoryMemberProperties$outboundSchema = exports.DirectoryMemberProperties$inboundSchema = exports.DirectoryMemberProperties = void 0;
+exports.ToolHttpMethod$ = exports.ToolHttpMethod$outboundSchema = exports.ToolHttpMethod$inboundSchema = exports.ToolHttpMethod = void 0;
 const z = __importStar(require("zod"));
-exports.DirectoryMemberProperties = {
-    Id: "id",
-    Name: "name",
-    Type: "type",
-    Extensions: "extensions",
-    ContactTags: "contact_tags",
-    UpdatedAt: "updated_at",
+/**
+ * The HTTP method to use for a tool HTTP request.
+ */
+exports.ToolHttpMethod = {
+    Get: "get",
+    Post: "post",
 };
 /** @internal */
-exports.DirectoryMemberProperties$inboundSchema = z.nativeEnum(exports.DirectoryMemberProperties);
+exports.ToolHttpMethod$inboundSchema = z.nativeEnum(exports.ToolHttpMethod);
 /** @internal */
-exports.DirectoryMemberProperties$outboundSchema = exports.DirectoryMemberProperties$inboundSchema;
+exports.ToolHttpMethod$outboundSchema = exports.ToolHttpMethod$inboundSchema;
 /**
  * @internal
  * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
  */
-var DirectoryMemberProperties$;
-(function (DirectoryMemberProperties$) {
-    /** @deprecated use `DirectoryMemberProperties$inboundSchema` instead. */
-    DirectoryMemberProperties$.inboundSchema = exports.DirectoryMemberProperties$inboundSchema;
-    /** @deprecated use `DirectoryMemberProperties$outboundSchema` instead. */
-    DirectoryMemberProperties$.outboundSchema = exports.DirectoryMemberProperties$outboundSchema;
-})(DirectoryMemberProperties$ || (exports.DirectoryMemberProperties$ = DirectoryMemberProperties$ = {}));
-//# sourceMappingURL=directorymemberproperties.js.map
+var ToolHttpMethod$;
+(function (ToolHttpMethod$) {
+    /** @deprecated use `ToolHttpMethod$inboundSchema` instead. */
+    ToolHttpMethod$.inboundSchema = exports.ToolHttpMethod$inboundSchema;
+    /** @deprecated use `ToolHttpMethod$outboundSchema` instead. */
+    ToolHttpMethod$.outboundSchema = exports.ToolHttpMethod$outboundSchema;
+})(ToolHttpMethod$ || (exports.ToolHttpMethod$ = ToolHttpMethod$ = {}));
+//# sourceMappingURL=toolhttpmethod.js.map

package/models/components/toolhttpmethod.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"toolhttpmethod.js","sourceRoot":"","sources":["../../src/models/components/toolhttpmethod.ts"],"names":[],"mappings":";AAAA;;GAEG;;;;;;;;;;;;;;;;;;;;;;;;;;AAEH,uCAAyB;AAGzB;;GAEG;AACU,QAAA,cAAc,GAAG;IAC5B,GAAG,EAAE,KAAK;IACV,IAAI,EAAE,MAAM;CACJ,CAAC;AAMX,gBAAgB;AACH,QAAA,4BAA4B,GAErC,CAAC,CAAC,UAAU,CAAC,sBAAc,CAAC,CAAC;AAEjC,gBAAgB;AACH,QAAA,6BAA6B,GAEtC,oCAA4B,CAAC;AAEjC;;;GAGG;AACH,IAAiB,eAAe,CAK/B;AALD,WAAiB,eAAe;IAC9B,8DAA8D;IACjD,6BAAa,GAAG,oCAA4B,CAAC;IAC1D,+DAA+D;IAClD,8BAAc,GAAG,qCAA6B,CAAC;AAC9D,CAAC,EALgB,eAAe,+BAAf,eAAe,QAK/B"}

package/models/components/toolparameterdefault.d.ts

@@ -3,11 +3,11 @@ import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 import { ToolParameterTransform, ToolParameterTransform$Outbound } from "./toolparametertransform.js";
 /**
- * The default value for a parameter of the tool call.
+ * The default value for a parameter of a tool call.
  */
 export type ToolParameterDefault = {
     /**
-     * A transform to be applied to the value of a parameter.
+     * A transform to be applied to the value of a tool parameter.
      *
      * @remarks
      *

package/models/components/toolparametertransform.d.ts

@@ -4,7 +4,7 @@ import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 import { ToolParameterTransformCondition, ToolParameterTransformCondition$Outbound } 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.
+ * 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 declare const Action: {
     readonly Default: "default";
@@ -12,11 +12,11 @@ export declare const Action: {
     readonly Remove: "remove";
 };
 /**
- * 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.
+ * 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 parameter.
+ * A transform to be applied to the value of a tool parameter.
  *
  * @remarks
  *
@@ -26,7 +26,7 @@ export type Action = ClosedEnum<typeof Action>;
  */
 export type ToolParameterTransform = {
     /**
-     * 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.
+     * 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;
     /**

package/models/components/toolparametertransform.js

@@ -33,7 +33,7 @@ const z = __importStar(require("zod"));
 const schemas_js_1 = require("../../lib/schemas.js");
 const toolparametertransformcondition_js_1 = require("./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.
+ * 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.
  */
 exports.Action = {
     Default: "default",

package/models/components/toolparametertransformcondition.d.ts

@@ -2,7 +2,7 @@ import * as z from "zod";
 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 parameter.
+ * A condition to be met for a transform to be applied to the value of a tool parameter.
  */
 export type ToolParameterTransformCondition = {
     /**

package/models/components/toolresponse.d.ts

@@ -0,0 +1,149 @@
+import * as z from "zod";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import { ToolDefinition, ToolDefinition$Outbound } 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.
+     *
+     * @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;
+    /**
+     * The ID of the tool
+     */
+    id: number;
+    /**
+     * The name of the service to which the tool belongs
+     */
+    serviceName?: string | null | undefined;
+};
+/** @internal */
+export declare const ToolResponse$inboundSchema: z.ZodType<ToolResponse, z.ZodTypeDef, unknown>;
+/** @internal */
+export type ToolResponse$Outbound = {
+    name: string;
+    definition: ToolDefinition$Outbound;
+    service_id: number;
+    id: number;
+    service_name?: string | null | undefined;
+};
+/** @internal */
+export declare const ToolResponse$outboundSchema: z.ZodType<ToolResponse$Outbound, z.ZodTypeDef, ToolResponse>;
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export declare namespace ToolResponse$ {
+    /** @deprecated use `ToolResponse$inboundSchema` instead. */
+    const inboundSchema: z.ZodType<ToolResponse, z.ZodTypeDef, unknown>;
+    /** @deprecated use `ToolResponse$outboundSchema` instead. */
+    const outboundSchema: z.ZodType<ToolResponse$Outbound, z.ZodTypeDef, ToolResponse>;
+    /** @deprecated use `ToolResponse$Outbound` instead. */
+    type Outbound = ToolResponse$Outbound;
+}
+export declare function toolResponseToJSON(toolResponse: ToolResponse): string;
+export declare function toolResponseFromJSON(jsonString: string): SafeParseResult<ToolResponse, SDKValidationError>;
+//# sourceMappingURL=toolresponse.d.ts.map

package/models/components/toolresponse.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"toolresponse.d.ts","sourceRoot":"","sources":["../../src/models/components/toolresponse.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAC;AAGzB,OAAO,EAAE,MAAM,IAAI,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAC9D,OAAO,EAAE,kBAAkB,EAAE,MAAM,iCAAiC,CAAC;AACrE,OAAO,EACL,cAAc,EAEd,uBAAuB,EAExB,MAAM,qBAAqB,CAAC;AAE7B;;;;;;GAMG;AACH,MAAM,MAAM,YAAY,GAAG;IACzB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2FG;IACH,UAAU,EAAE,cAAc,CAAC;IAC3B;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IACX;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;CACzC,CAAC;AAEF,gBAAgB;AAChB,eAAO,MAAM,0BAA0B,EAAE,CAAC,CAAC,OAAO,CAChD,YAAY,EACZ,CAAC,CAAC,UAAU,EACZ,OAAO,CAYP,CAAC;AAEH,gBAAgB;AAChB,MAAM,MAAM,qBAAqB,GAAG;IAClC,IAAI,EAAE,MAAM,CAAC;IACb,UAAU,EAAE,uBAAuB,CAAC;IACpC,UAAU,EAAE,MAAM,CAAC;IACnB,EAAE,EAAE,MAAM,CAAC;IACX,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;CAC1C,CAAC;AAEF,gBAAgB;AAChB,eAAO,MAAM,2BAA2B,EAAE,CAAC,CAAC,OAAO,CACjD,qBAAqB,EACrB,CAAC,CAAC,UAAU,EACZ,YAAY,CAYZ,CAAC;AAEH;;;GAGG;AACH,yBAAiB,aAAa,CAAC;IAC7B,4DAA4D;IACrD,MAAM,aAAa,gDAA6B,CAAC;IACxD,6DAA6D;IACtD,MAAM,cAAc,8DAA8B,CAAC;IAC1D,uDAAuD;IACvD,KAAY,QAAQ,GAAG,qBAAqB,CAAC;CAC9C;AAED,wBAAgB,kBAAkB,CAAC,YAAY,EAAE,YAAY,GAAG,MAAM,CAErE;AAED,wBAAgB,oBAAoB,CAClC,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,YAAY,EAAE,kBAAkB,CAAC,CAMnD"}