syllable-sdk 0.1.0-alpha.27 → 0.1.0-alpha.28

package/src/models/components/httpendpoint.ts

@@ -0,0 +1,158 @@
+/*
+ * 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";
+
+/**
+ * The HTTP method to use for the service call.
+ */
+export const Method = {
+  Get: "get",
+  Post: "post",
+} as const;
+/**
+ * The HTTP method to use for the service call.
+ */
+export type Method = ClosedEnum<typeof Method>;
+
+/**
+ * How to pass the arguments to the request.
+ */
+export const ArgumentLocation = {
+  Body: "body",
+  Form: "form",
+  Path: "path",
+  Query: "query",
+} as const;
+/**
+ * How to pass the arguments to the request.
+ */
+export type ArgumentLocation = ClosedEnum<typeof ArgumentLocation>;
+
+/**
+ * The configuration for an HTTP API call.
+ */
+export type HttpEndpoint = {
+  /**
+   * The endpoint URL of the external service to call.
+   */
+  url: string;
+  /**
+   * The HTTP method to use for the service call.
+   */
+  method: Method;
+  /**
+   * How to pass the arguments to the request.
+   */
+  argumentLocation: ArgumentLocation;
+};
+
+/** @internal */
+export const Method$inboundSchema: z.ZodNativeEnum<typeof Method> = z
+  .nativeEnum(Method);
+
+/** @internal */
+export const Method$outboundSchema: z.ZodNativeEnum<typeof Method> =
+  Method$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace Method$ {
+  /** @deprecated use `Method$inboundSchema` instead. */
+  export const inboundSchema = Method$inboundSchema;
+  /** @deprecated use `Method$outboundSchema` instead. */
+  export const outboundSchema = Method$outboundSchema;
+}
+
+/** @internal */
+export const ArgumentLocation$inboundSchema: z.ZodNativeEnum<
+  typeof ArgumentLocation
+> = z.nativeEnum(ArgumentLocation);
+
+/** @internal */
+export const ArgumentLocation$outboundSchema: z.ZodNativeEnum<
+  typeof ArgumentLocation
+> = ArgumentLocation$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace ArgumentLocation$ {
+  /** @deprecated use `ArgumentLocation$inboundSchema` instead. */
+  export const inboundSchema = ArgumentLocation$inboundSchema;
+  /** @deprecated use `ArgumentLocation$outboundSchema` instead. */
+  export const outboundSchema = ArgumentLocation$outboundSchema;
+}
+
+/** @internal */
+export const HttpEndpoint$inboundSchema: z.ZodType<
+  HttpEndpoint,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  url: z.string(),
+  method: Method$inboundSchema,
+  argument_location: ArgumentLocation$inboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    "argument_location": "argumentLocation",
+  });
+});
+
+/** @internal */
+export type HttpEndpoint$Outbound = {
+  url: string;
+  method: string;
+  argument_location: string;
+};
+
+/** @internal */
+export const HttpEndpoint$outboundSchema: z.ZodType<
+  HttpEndpoint$Outbound,
+  z.ZodTypeDef,
+  HttpEndpoint
+> = z.object({
+  url: z.string(),
+  method: Method$outboundSchema,
+  argumentLocation: ArgumentLocation$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 HttpEndpoint$ {
+  /** @deprecated use `HttpEndpoint$inboundSchema` instead. */
+  export const inboundSchema = HttpEndpoint$inboundSchema;
+  /** @deprecated use `HttpEndpoint$outboundSchema` instead. */
+  export const outboundSchema = HttpEndpoint$outboundSchema;
+  /** @deprecated use `HttpEndpoint$Outbound` instead. */
+  export type Outbound = HttpEndpoint$Outbound;
+}
+
+export function httpEndpointToJSON(httpEndpoint: HttpEndpoint): string {
+  return JSON.stringify(HttpEndpoint$outboundSchema.parse(httpEndpoint));
+}
+
+export function httpEndpointFromJSON(
+  jsonString: string,
+): SafeParseResult<HttpEndpoint, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => HttpEndpoint$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'HttpEndpoint' from JSON`,
+  );
+}

package/src/models/components/index.ts

@@ -37,6 +37,8 @@ export * from "./directorymembercreate.js";
 export * from "./directorymemberproperties.js";
 export * from "./event.js";
 export * from "./eventproperties.js";
+export * from "./function.js";
+export * from "./httpendpoint.js";
 export * from "./listresponseagentresponse.js";
 export * from "./listresponseavailabletarget.js";
 export * from "./listresponsechannel.js";
@@ -57,6 +59,9 @@ export * from "./promptcreate.js";
 export * from "./prompthistory.js";
 export * from "./promptproperties.js";
 export * from "./promptupdate.js";
+export * from "./provider.js";
+export * from "./sdkinternaltool.js";
+export * from "./sdktooldefinition.js";
 export * from "./security.js";
 export * from "./service.js";
 export * from "./servicecreate.js";
@@ -79,6 +84,9 @@ export * from "./testmessageresponse.js";
 export * from "./tool.js";
 export * from "./toolcreate.js";
 export * from "./tooldetailresponse.js";
+export * from "./toolparameterdefault.js";
+export * from "./toolparametertransform.js";
+export * from "./toolparametertransformcondition.js";
 export * from "./toolproperties.js";
 export * from "./toolupdate.js";
 export * from "./validationerror.js";

package/src/models/components/llmconfig.ts

@@ -5,25 +5,17 @@
 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";
-
-/**
- * Provider of the LLM model.
- */
-export const Provider = {
-  AzureOpenai: "azure_openai",
-  Openai: "openai",
-} as const;
-/**
- * Provider of the LLM model.
- */
-export type Provider = ClosedEnum<typeof Provider>;
+import {
+  Provider,
+  Provider$inboundSchema,
+  Provider$outboundSchema,
+} from "./provider.js";
 
 export type LlmConfig = {
   /**
-   * Provider of the LLM model.
+   * LLM API provider.
    */
   provider?: Provider | undefined;
   /**
@@ -40,32 +32,13 @@ export type LlmConfig = {
   apiVersion?: string | null | undefined;
 };
 
-/** @internal */
-export const Provider$inboundSchema: z.ZodNativeEnum<typeof Provider> = z
-  .nativeEnum(Provider);
-
-/** @internal */
-export const Provider$outboundSchema: z.ZodNativeEnum<typeof Provider> =
-  Provider$inboundSchema;
-
-/**
- * @internal
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
- */
-export namespace Provider$ {
-  /** @deprecated use `Provider$inboundSchema` instead. */
-  export const inboundSchema = Provider$inboundSchema;
-  /** @deprecated use `Provider$outboundSchema` instead. */
-  export const outboundSchema = Provider$outboundSchema;
-}
-
 /** @internal */
 export const LlmConfig$inboundSchema: z.ZodType<
   LlmConfig,
   z.ZodTypeDef,
   unknown
 > = z.object({
-  provider: Provider$inboundSchema.default("azure_openai"),
+  provider: Provider$inboundSchema.optional(),
   model: z.string().default("gpt-4o"),
   version: z.nullable(z.string()).optional(),
   api_version: z.nullable(z.string()).optional(),
@@ -77,7 +50,7 @@ export const LlmConfig$inboundSchema: z.ZodType<
 
 /** @internal */
 export type LlmConfig$Outbound = {
-  provider: string;
+  provider?: string | undefined;
   model: string;
   version?: string | null | undefined;
   api_version?: string | null | undefined;
@@ -89,7 +62,7 @@ export const LlmConfig$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   LlmConfig
 > = z.object({
-  provider: Provider$outboundSchema.default("azure_openai"),
+  provider: Provider$outboundSchema.optional(),
   model: z.string().default("gpt-4o"),
   version: z.nullable(z.string()).optional(),
   apiVersion: z.nullable(z.string()).optional(),

package/src/models/components/prompt.ts

@@ -35,9 +35,6 @@ export type Prompt = {
    * The tools for the prompt
    */
   tools?: Array<string> | undefined;
-  /**
-   * The configuration for the language model used by the Cortex API.
-   */
   llmConfig: LlmConfig;
   /**
    * The Prompt ID

package/src/models/components/promptcreate.ts

@@ -35,9 +35,6 @@ export type PromptCreate = {
    * The tools for the prompt
    */
   tools?: Array<string> | undefined;
-  /**
-   * The configuration for the language model used by the Cortex API.
-   */
   llmConfig: LlmConfig;
 };
 

package/src/models/components/promptupdate.ts

@@ -35,9 +35,6 @@ export type PromptUpdate = {
    * The tools for the prompt
    */
   tools?: Array<string> | undefined;
-  /**
-   * The configuration for the language model used by the Cortex API.
-   */
   llmConfig: LlmConfig;
   /**
    * The Prompt ID

package/src/models/components/provider.ts

@@ -0,0 +1,37 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { ClosedEnum } from "../../types/enums.js";
+
+/**
+ * LLM API provider.
+ */
+export const Provider = {
+  AzureOpenai: "azure_openai",
+  Openai: "openai",
+} as const;
+/**
+ * LLM API provider.
+ */
+export type Provider = ClosedEnum<typeof Provider>;
+
+/** @internal */
+export const Provider$inboundSchema: z.ZodNativeEnum<typeof Provider> = z
+  .nativeEnum(Provider);
+
+/** @internal */
+export const Provider$outboundSchema: z.ZodNativeEnum<typeof Provider> =
+  Provider$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace Provider$ {
+  /** @deprecated use `Provider$inboundSchema` instead. */
+  export const inboundSchema = Provider$inboundSchema;
+  /** @deprecated use `Provider$outboundSchema` instead. */
+  export const outboundSchema = Provider$outboundSchema;
+}

package/src/models/components/sdkinternaltool.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";
+import {
+  FunctionT,
+  FunctionT$inboundSchema,
+  FunctionT$Outbound,
+  FunctionT$outboundSchema,
+} from "./function.js";
+
+/**
+ * A tool definition to be used by the OpenAI API.
+ */
+export type SDKInternalTool = {
+  /**
+   * Always `function`.
+   */
+  type?: "function" | undefined;
+  /**
+   * A tool definition to be used by the OpenAI API.
+   *
+   * @remarks
+   *
+   * See:
+   * - https://learn.microsoft.com/en-us/azure/ai-services/openai/how-to/function-calling
+   */
+  function: FunctionT;
+};
+
+/** @internal */
+export const SDKInternalTool$inboundSchema: z.ZodType<
+  SDKInternalTool,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  type: z.literal("function").default("function"),
+  function: FunctionT$inboundSchema,
+});
+
+/** @internal */
+export type SDKInternalTool$Outbound = {
+  type: "function";
+  function: FunctionT$Outbound;
+};
+
+/** @internal */
+export const SDKInternalTool$outboundSchema: z.ZodType<
+  SDKInternalTool$Outbound,
+  z.ZodTypeDef,
+  SDKInternalTool
+> = z.object({
+  type: z.literal("function").default("function" as const),
+  function: FunctionT$outboundSchema,
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace SDKInternalTool$ {
+  /** @deprecated use `SDKInternalTool$inboundSchema` instead. */
+  export const inboundSchema = SDKInternalTool$inboundSchema;
+  /** @deprecated use `SDKInternalTool$outboundSchema` instead. */
+  export const outboundSchema = SDKInternalTool$outboundSchema;
+  /** @deprecated use `SDKInternalTool$Outbound` instead. */
+  export type Outbound = SDKInternalTool$Outbound;
+}
+
+export function sdkInternalToolToJSON(
+  sdkInternalTool: SDKInternalTool,
+): string {
+  return JSON.stringify(SDKInternalTool$outboundSchema.parse(sdkInternalTool));
+}
+
+export function sdkInternalToolFromJSON(
+  jsonString: string,
+): SafeParseResult<SDKInternalTool, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SDKInternalTool$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SDKInternalTool' from JSON`,
+  );
+}