syllable-sdk 0.1.0-alpha.7 → 0.1.0-alpha.71

package/src/models/components/toolcreaterequest.ts

@@ -0,0 +1,101 @@
+/*
+ * 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";
+
+/**
+ * Request model to create a tool.
+ */
+export type ToolCreateRequest = {
+  /**
+   * The name of the tool
+   */
+  name: string;
+  /**
+   * A tool that can be called from an LLM during the conversation. See https://docs.syllable.ai/Resources/Tools.
+   */
+  definition: ToolDefinition;
+  /**
+   * Internal ID of the service to which the tool belongs
+   */
+  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,226 @@
+/*
+ * 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 { 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 {
+  StaticToolParameter,
+  StaticToolParameter$inboundSchema,
+  StaticToolParameter$Outbound,
+  StaticToolParameter$outboundSchema,
+} from "./statictoolparameter.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>;
+
+/**
+ * The default values for the parameters of the function/tool call.
+ */
+export type Defaults = any | { [k: string]: ToolParameterDefault };
+
+/**
+ * A tool that can be called from an LLM during the conversation. See https://docs.syllable.ai/Resources/Tools.
+ */
+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?: any | { [k: string]: ToolParameterDefault } | null | undefined;
+  /**
+   * Parameters for the tool whose values should be set at config time (i.e., not provided by the LLM).
+   */
+  staticParameters?: Array<StaticToolParameter> | null | undefined;
+  /**
+   * The optional result of the tool call. Only used for `context` tools.
+   */
+  result?: any | 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 Defaults$inboundSchema: z.ZodType<
+  Defaults,
+  z.ZodTypeDef,
+  unknown
+> = z.union([z.any(), z.record(ToolParameterDefault$inboundSchema)]);
+
+/** @internal */
+export type Defaults$Outbound = any | {
+  [k: string]: ToolParameterDefault$Outbound;
+};
+
+/** @internal */
+export const Defaults$outboundSchema: z.ZodType<
+  Defaults$Outbound,
+  z.ZodTypeDef,
+  Defaults
+> = z.union([z.any(), 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 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.any(), z.record(ToolParameterDefault$inboundSchema)]),
+  ).optional(),
+  static_parameters: z.nullable(z.array(StaticToolParameter$inboundSchema))
+    .optional(),
+  result: z.nullable(z.any()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "static_parameters": "staticParameters",
+  });
+});
+
+/** @internal */
+export type ToolDefinition$Outbound = {
+  type?: string | null | undefined;
+  tool: InternalTool$Outbound;
+  endpoint?: ToolHttpEndpoint$Outbound | null | undefined;
+  defaults?:
+    | any
+    | { [k: string]: ToolParameterDefault$Outbound }
+    | null
+    | undefined;
+  static_parameters?: Array<StaticToolParameter$Outbound> | null | undefined;
+  result?: any | 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.any(), z.record(ToolParameterDefault$outboundSchema)]),
+  ).optional(),
+  staticParameters: z.nullable(z.array(StaticToolParameter$outboundSchema))
+    .optional(),
+  result: z.nullable(z.any()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    staticParameters: "static_parameters",
+  });
+});
+
+/**
+ * @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,13 +3,82 @@
  */
 
 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 {
+  ToolAgentInfo,
+  ToolAgentInfo$inboundSchema,
+  ToolAgentInfo$Outbound,
+  ToolAgentInfo$outboundSchema,
+} from "./toolagentinfo.js";
+import {
+  ToolDefinition,
+  ToolDefinition$inboundSchema,
+  ToolDefinition$Outbound,
+  ToolDefinition$outboundSchema,
+} from "./tooldefinition.js";
+import {
+  ToolPromptInfo,
+  ToolPromptInfo$inboundSchema,
+  ToolPromptInfo$Outbound,
+  ToolPromptInfo$outboundSchema,
+} from "./toolpromptinfo.js";
 
+/**
+ * Response model for tool detail endpoint.
+ *
+ * @remarks
+ * A tool is a function that an agent can call to perform actions like accessing databases,
+ * 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.
+ * For more information, see [Console docs](https://docs.syllable.ai/Resources/Tools).
+ */
 export type ToolDetailResponse = {
+  /**
+   * The name of the tool
+   */
   name: string;
-  description: string;
+  /**
+   * A tool that can be called from an LLM during the conversation. See https://docs.syllable.ai/Resources/Tools.
+   */
+  definition: ToolDefinition;
+  /**
+   * Internal ID of the service to which the tool belongs
+   */
+  serviceId: number;
+  /**
+   * The internal ID of the tool
+   */
+  id: number;
+  /**
+   * Comments for the most recent edit to the tool.
+   */
+  lastUpdatedComments?: string | null | undefined;
+  /**
+   * The name of the service to which the tool belongs
+   */
+  serviceName?: string | null | undefined;
+  /**
+   * IDs and names of the prompts linked to the tool
+   */
+  promptsInfo?: Array<ToolPromptInfo> | null | undefined;
+  /**
+   * IDs and names of the agents linked to the tool via a prompt
+   */
+  agentsInfo?: Array<ToolAgentInfo> | 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;
+  /**
+   * Fields that the tool accepts as input
+   */
   fields: Array<string>;
 };
 
@@ -20,14 +89,42 @@ export const ToolDetailResponse$inboundSchema: z.ZodType<
   unknown
 > = z.object({
   name: z.string(),
-  description: 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(),
+  prompts_info: z.nullable(z.array(ToolPromptInfo$inboundSchema)).optional(),
+  agents_info: z.nullable(z.array(ToolAgentInfo$inboundSchema)).optional(),
+  last_updated: z.string().datetime({ offset: true }).transform(v =>
+    new Date(v)
+  ),
+  last_updated_by: z.string(),
   fields: z.array(z.string()),
+}).transform((v) => {
+  return remap$(v, {
+    "service_id": "serviceId",
+    "last_updated_comments": "lastUpdatedComments",
+    "service_name": "serviceName",
+    "prompts_info": "promptsInfo",
+    "agents_info": "agentsInfo",
+    "last_updated": "lastUpdated",
+    "last_updated_by": "lastUpdatedBy",
+  });
 });
 
 /** @internal */
 export type ToolDetailResponse$Outbound = {
   name: string;
-  description: string;
+  definition: ToolDefinition$Outbound;
+  service_id: number;
+  id: number;
+  last_updated_comments?: string | null | undefined;
+  service_name?: string | null | undefined;
+  prompts_info?: Array<ToolPromptInfo$Outbound> | null | undefined;
+  agents_info?: Array<ToolAgentInfo$Outbound> | null | undefined;
+  last_updated: string;
+  last_updated_by: string;
   fields: Array<string>;
 };
 
@@ -38,8 +135,26 @@ export const ToolDetailResponse$outboundSchema: z.ZodType<
   ToolDetailResponse
 > = z.object({
   name: z.string(),
-  description: 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(),
+  promptsInfo: z.nullable(z.array(ToolPromptInfo$outboundSchema)).optional(),
+  agentsInfo: z.nullable(z.array(ToolAgentInfo$outboundSchema)).optional(),
+  lastUpdated: z.date().transform(v => v.toISOString()),
+  lastUpdatedBy: z.string(),
   fields: z.array(z.string()),
+}).transform((v) => {
+  return remap$(v, {
+    serviceId: "service_id",
+    lastUpdatedComments: "last_updated_comments",
+    serviceName: "service_name",
+    promptsInfo: "prompts_info",
+    agentsInfo: "agents_info",
+    lastUpdated: "last_updated",
+    lastUpdatedBy: "last_updated_by",
+  });
 });
 
 /**

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`,
+  );
+}