@orq-ai/node 2.14.6 → 3.0.1

package/models/components/deployments.d.ts

@@ -0,0 +1,920 @@
+import * as z from "zod";
+import { ClosedEnum } from "../../types/enums.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+export type Inputs = string | number | boolean;
+/**
+ * The role of the prompt message
+ */
+export declare const Role: {
+    readonly System: "system";
+    readonly Assistant: "assistant";
+    readonly User: "user";
+    readonly Exception: "exception";
+    readonly Tool: "tool";
+    readonly Prompt: "prompt";
+    readonly Correction: "correction";
+    readonly ExpectedOutput: "expected_output";
+};
+/**
+ * The role of the prompt message
+ */
+export type Role = ClosedEnum<typeof Role>;
+export declare const TwoType: {
+    readonly ImageUrl: "image_url";
+};
+export type TwoType = ClosedEnum<typeof TwoType>;
+export type ImageUrl = {
+    /**
+     * Either a URL of the image or the base64 encoded data URI.
+     */
+    url: string;
+    /**
+     * Specifies the detail level of the image. Currently only supported with OpenAI models
+     */
+    detail?: string | undefined;
+};
+/**
+ * The image part of the prompt message. Only supported with vision models.
+ */
+export type Two2 = {
+    type: TwoType;
+    imageUrl: ImageUrl;
+};
+export declare const Deployments2Type: {
+    readonly Text: "text";
+};
+export type Deployments2Type = ClosedEnum<typeof Deployments2Type>;
+/**
+ * Text content part of a prompt message
+ */
+export type One = {
+    type: Deployments2Type;
+    text: string;
+};
+export type Two = One | Two2;
+/**
+ * The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts.
+ */
+export type Content = string | Array<One | Two2>;
+export declare const Type: {
+    readonly Function: "function";
+};
+export type Type = ClosedEnum<typeof Type>;
+export type FunctionT = {
+    name: string;
+    /**
+     * JSON string arguments for the functions
+     */
+    arguments: string;
+};
+export type ToolCalls = {
+    id?: string | undefined;
+    index?: number | undefined;
+    type: Type;
+    function: FunctionT;
+};
+export type PrefixMessages = {
+    /**
+     * The role of the prompt message
+     */
+    role: Role;
+    /**
+     * The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts.
+     */
+    content: string | Array<One | Two2>;
+    toolCalls?: Array<ToolCalls> | undefined;
+};
+/**
+ * The role of the prompt message
+ */
+export declare const DeploymentsRole: {
+    readonly System: "system";
+    readonly Assistant: "assistant";
+    readonly User: "user";
+    readonly Exception: "exception";
+    readonly Tool: "tool";
+    readonly Prompt: "prompt";
+    readonly Correction: "correction";
+    readonly ExpectedOutput: "expected_output";
+};
+/**
+ * The role of the prompt message
+ */
+export type DeploymentsRole = ClosedEnum<typeof DeploymentsRole>;
+export declare const Deployments2MessagesContentType: {
+    readonly ImageUrl: "image_url";
+};
+export type Deployments2MessagesContentType = ClosedEnum<typeof Deployments2MessagesContentType>;
+export type TwoImageUrl = {
+    /**
+     * Either a URL of the image or the base64 encoded data URI.
+     */
+    url: string;
+    /**
+     * Specifies the detail level of the image. Currently only supported with OpenAI models
+     */
+    detail?: string | undefined;
+};
+/**
+ * The image part of the prompt message. Only supported with vision models.
+ */
+export type Deployments22 = {
+    type: Deployments2MessagesContentType;
+    imageUrl: TwoImageUrl;
+};
+export declare const Deployments2MessagesType: {
+    readonly Text: "text";
+};
+export type Deployments2MessagesType = ClosedEnum<typeof Deployments2MessagesType>;
+/**
+ * Text content part of a prompt message
+ */
+export type Two1 = {
+    type: Deployments2MessagesType;
+    text: string;
+};
+export type Content2 = Two1 | Deployments22;
+/**
+ * The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts.
+ */
+export type DeploymentsContent = string | Array<Two1 | Deployments22>;
+export declare const DeploymentsType: {
+    readonly Function: "function";
+};
+export type DeploymentsType = ClosedEnum<typeof DeploymentsType>;
+export type DeploymentsFunction = {
+    name: string;
+    /**
+     * JSON string arguments for the functions
+     */
+    arguments: string;
+};
+export type DeploymentsToolCalls = {
+    id?: string | undefined;
+    index?: number | undefined;
+    type: DeploymentsType;
+    function: DeploymentsFunction;
+};
+export type Messages = {
+    /**
+     * The role of the prompt message
+     */
+    role: DeploymentsRole;
+    /**
+     * The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts.
+     */
+    content: string | Array<Two1 | Deployments22>;
+    toolCalls?: Array<DeploymentsToolCalls> | undefined;
+};
+/**
+ * Metadata about the document
+ */
+export type Metadata = {
+    /**
+     * Name of the file the text is from.
+     */
+    fileName?: string | undefined;
+    /**
+     * Content type of the file the text is from.
+     */
+    fileType?: string | undefined;
+    /**
+     * The page number the text is from.
+     */
+    pageNumber?: number | undefined;
+};
+export type Documents = {
+    /**
+     * The text content of the document
+     */
+    text: string;
+    /**
+     * Metadata about the document
+     */
+    metadata?: Metadata | undefined;
+};
+export type InvokeOptions = {
+    /**
+     * Whether to include the retrieved knowledge chunks in the response.
+     */
+    includeRetrievals?: boolean | undefined;
+};
+/**
+ * The deployment request payload
+ */
+export type Deployments = {
+    /**
+     * The deployment key to invoke
+     */
+    key: string;
+    /**
+     * If set, partial message content will be sent. Tokens will be sent as data-only `server-sent events` as they become available, with the stream terminated by a `data: [DONE]` message.
+     */
+    stream?: boolean | undefined;
+    /**
+     * Key-value pairs variables to replace in your prompts. If a variable is not provided that is defined in the prompt, the default variables are used.
+     */
+    inputs?: {
+        [k: string]: string | number | boolean;
+    } | undefined;
+    /**
+     * Key-value pairs that match your data model and fields declared in your configuration matrix. If you send multiple prompt keys, the context will be applied to the evaluation of each key.
+     */
+    context?: {
+        [k: string]: any;
+    } | undefined;
+    /**
+     * A list of messages to include after the `System` message, but before the  `User` and `Assistant` pairs configured in your deployment.
+     */
+    prefixMessages?: Array<PrefixMessages> | undefined;
+    /**
+     * A list of messages to send to the deployment.
+     */
+    messages?: Array<Messages> | undefined;
+    /**
+     * A list of file IDs that are associated with the deployment request.
+     */
+    fileIds?: Array<string> | undefined;
+    /**
+     * Key-value pairs that you want to attach to the log generated by this request.
+     */
+    metadata?: {
+        [k: string]: any;
+    } | undefined;
+    /**
+     * Utilized for passing additional parameters to the model provider. Exercise caution when using this feature, as the included parameters will overwrite any parameters specified in the deployment prompt configuration.
+     */
+    extraParams?: {
+        [k: string]: any;
+    } | undefined;
+    /**
+     * A list of relevant documents that evaluators and guardrails can cite to evaluate the user input or the model response based on your deployment settings.
+     */
+    documents?: Array<Documents> | undefined;
+    invokeOptions?: InvokeOptions | undefined;
+};
+/** @internal */
+export declare const Inputs$inboundSchema: z.ZodType<Inputs, z.ZodTypeDef, unknown>;
+/** @internal */
+export type Inputs$Outbound = string | number | boolean;
+/** @internal */
+export declare const Inputs$outboundSchema: z.ZodType<Inputs$Outbound, z.ZodTypeDef, Inputs>;
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export declare namespace Inputs$ {
+    /** @deprecated use `Inputs$inboundSchema` instead. */
+    const inboundSchema: z.ZodType<Inputs, z.ZodTypeDef, unknown>;
+    /** @deprecated use `Inputs$outboundSchema` instead. */
+    const outboundSchema: z.ZodType<Inputs$Outbound, z.ZodTypeDef, Inputs>;
+    /** @deprecated use `Inputs$Outbound` instead. */
+    type Outbound = Inputs$Outbound;
+}
+export declare function inputsToJSON(inputs: Inputs): string;
+export declare function inputsFromJSON(jsonString: string): SafeParseResult<Inputs, SDKValidationError>;
+/** @internal */
+export declare const Role$inboundSchema: z.ZodNativeEnum<typeof Role>;
+/** @internal */
+export declare const Role$outboundSchema: z.ZodNativeEnum<typeof Role>;
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export declare namespace Role$ {
+    /** @deprecated use `Role$inboundSchema` instead. */
+    const inboundSchema: z.ZodNativeEnum<{
+        readonly System: "system";
+        readonly Assistant: "assistant";
+        readonly User: "user";
+        readonly Exception: "exception";
+        readonly Tool: "tool";
+        readonly Prompt: "prompt";
+        readonly Correction: "correction";
+        readonly ExpectedOutput: "expected_output";
+    }>;
+    /** @deprecated use `Role$outboundSchema` instead. */
+    const outboundSchema: z.ZodNativeEnum<{
+        readonly System: "system";
+        readonly Assistant: "assistant";
+        readonly User: "user";
+        readonly Exception: "exception";
+        readonly Tool: "tool";
+        readonly Prompt: "prompt";
+        readonly Correction: "correction";
+        readonly ExpectedOutput: "expected_output";
+    }>;
+}
+/** @internal */
+export declare const TwoType$inboundSchema: z.ZodNativeEnum<typeof TwoType>;
+/** @internal */
+export declare const TwoType$outboundSchema: z.ZodNativeEnum<typeof TwoType>;
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export declare namespace TwoType$ {
+    /** @deprecated use `TwoType$inboundSchema` instead. */
+    const inboundSchema: z.ZodNativeEnum<{
+        readonly ImageUrl: "image_url";
+    }>;
+    /** @deprecated use `TwoType$outboundSchema` instead. */
+    const outboundSchema: z.ZodNativeEnum<{
+        readonly ImageUrl: "image_url";
+    }>;
+}
+/** @internal */
+export declare const ImageUrl$inboundSchema: z.ZodType<ImageUrl, z.ZodTypeDef, unknown>;
+/** @internal */
+export type ImageUrl$Outbound = {
+    url: string;
+    detail?: string | undefined;
+};
+/** @internal */
+export declare const ImageUrl$outboundSchema: z.ZodType<ImageUrl$Outbound, z.ZodTypeDef, ImageUrl>;
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export declare namespace ImageUrl$ {
+    /** @deprecated use `ImageUrl$inboundSchema` instead. */
+    const inboundSchema: z.ZodType<ImageUrl, z.ZodTypeDef, unknown>;
+    /** @deprecated use `ImageUrl$outboundSchema` instead. */
+    const outboundSchema: z.ZodType<ImageUrl$Outbound, z.ZodTypeDef, ImageUrl>;
+    /** @deprecated use `ImageUrl$Outbound` instead. */
+    type Outbound = ImageUrl$Outbound;
+}
+export declare function imageUrlToJSON(imageUrl: ImageUrl): string;
+export declare function imageUrlFromJSON(jsonString: string): SafeParseResult<ImageUrl, SDKValidationError>;
+/** @internal */
+export declare const Two2$inboundSchema: z.ZodType<Two2, z.ZodTypeDef, unknown>;
+/** @internal */
+export type Two2$Outbound = {
+    type: string;
+    image_url: ImageUrl$Outbound;
+};
+/** @internal */
+export declare const Two2$outboundSchema: z.ZodType<Two2$Outbound, z.ZodTypeDef, Two2>;
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export declare namespace Two2$ {
+    /** @deprecated use `Two2$inboundSchema` instead. */
+    const inboundSchema: z.ZodType<Two2, z.ZodTypeDef, unknown>;
+    /** @deprecated use `Two2$outboundSchema` instead. */
+    const outboundSchema: z.ZodType<Two2$Outbound, z.ZodTypeDef, Two2>;
+    /** @deprecated use `Two2$Outbound` instead. */
+    type Outbound = Two2$Outbound;
+}
+export declare function two2ToJSON(two2: Two2): string;
+export declare function two2FromJSON(jsonString: string): SafeParseResult<Two2, SDKValidationError>;
+/** @internal */
+export declare const Deployments2Type$inboundSchema: z.ZodNativeEnum<typeof Deployments2Type>;
+/** @internal */
+export declare const Deployments2Type$outboundSchema: z.ZodNativeEnum<typeof Deployments2Type>;
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export declare namespace Deployments2Type$ {
+    /** @deprecated use `Deployments2Type$inboundSchema` instead. */
+    const inboundSchema: z.ZodNativeEnum<{
+        readonly Text: "text";
+    }>;
+    /** @deprecated use `Deployments2Type$outboundSchema` instead. */
+    const outboundSchema: z.ZodNativeEnum<{
+        readonly Text: "text";
+    }>;
+}
+/** @internal */
+export declare const One$inboundSchema: z.ZodType<One, z.ZodTypeDef, unknown>;
+/** @internal */
+export type One$Outbound = {
+    type: string;
+    text: string;
+};
+/** @internal */
+export declare const One$outboundSchema: z.ZodType<One$Outbound, z.ZodTypeDef, One>;
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export declare namespace One$ {
+    /** @deprecated use `One$inboundSchema` instead. */
+    const inboundSchema: z.ZodType<One, z.ZodTypeDef, unknown>;
+    /** @deprecated use `One$outboundSchema` instead. */
+    const outboundSchema: z.ZodType<One$Outbound, z.ZodTypeDef, One>;
+    /** @deprecated use `One$Outbound` instead. */
+    type Outbound = One$Outbound;
+}
+export declare function oneToJSON(one: One): string;
+export declare function oneFromJSON(jsonString: string): SafeParseResult<One, SDKValidationError>;
+/** @internal */
+export declare const Two$inboundSchema: z.ZodType<Two, z.ZodTypeDef, unknown>;
+/** @internal */
+export type Two$Outbound = One$Outbound | Two2$Outbound;
+/** @internal */
+export declare const Two$outboundSchema: z.ZodType<Two$Outbound, z.ZodTypeDef, Two>;
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export declare namespace Two$ {
+    /** @deprecated use `Two$inboundSchema` instead. */
+    const inboundSchema: z.ZodType<Two, z.ZodTypeDef, unknown>;
+    /** @deprecated use `Two$outboundSchema` instead. */
+    const outboundSchema: z.ZodType<Two$Outbound, z.ZodTypeDef, Two>;
+    /** @deprecated use `Two$Outbound` instead. */
+    type Outbound = Two$Outbound;
+}
+export declare function twoToJSON(two: Two): string;
+export declare function twoFromJSON(jsonString: string): SafeParseResult<Two, SDKValidationError>;
+/** @internal */
+export declare const Content$inboundSchema: z.ZodType<Content, z.ZodTypeDef, unknown>;
+/** @internal */
+export type Content$Outbound = string | Array<One$Outbound | Two2$Outbound>;
+/** @internal */
+export declare const Content$outboundSchema: z.ZodType<Content$Outbound, z.ZodTypeDef, Content>;
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export declare namespace Content$ {
+    /** @deprecated use `Content$inboundSchema` instead. */
+    const inboundSchema: z.ZodType<Content, z.ZodTypeDef, unknown>;
+    /** @deprecated use `Content$outboundSchema` instead. */
+    const outboundSchema: z.ZodType<Content$Outbound, z.ZodTypeDef, Content>;
+    /** @deprecated use `Content$Outbound` instead. */
+    type Outbound = Content$Outbound;
+}
+export declare function contentToJSON(content: Content): string;
+export declare function contentFromJSON(jsonString: string): SafeParseResult<Content, SDKValidationError>;
+/** @internal */
+export declare const Type$inboundSchema: z.ZodNativeEnum<typeof Type>;
+/** @internal */
+export declare const Type$outboundSchema: z.ZodNativeEnum<typeof Type>;
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export declare namespace Type$ {
+    /** @deprecated use `Type$inboundSchema` instead. */
+    const inboundSchema: z.ZodNativeEnum<{
+        readonly Function: "function";
+    }>;
+    /** @deprecated use `Type$outboundSchema` instead. */
+    const outboundSchema: z.ZodNativeEnum<{
+        readonly Function: "function";
+    }>;
+}
+/** @internal */
+export declare const FunctionT$inboundSchema: z.ZodType<FunctionT, z.ZodTypeDef, unknown>;
+/** @internal */
+export type FunctionT$Outbound = {
+    name: string;
+    arguments: string;
+};
+/** @internal */
+export declare const FunctionT$outboundSchema: z.ZodType<FunctionT$Outbound, z.ZodTypeDef, FunctionT>;
+/**
+ * @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 function functionToJSON(functionT: FunctionT): string;
+export declare function functionFromJSON(jsonString: string): SafeParseResult<FunctionT, SDKValidationError>;
+/** @internal */
+export declare const ToolCalls$inboundSchema: z.ZodType<ToolCalls, z.ZodTypeDef, unknown>;
+/** @internal */
+export type ToolCalls$Outbound = {
+    id?: string | undefined;
+    index?: number | undefined;
+    type: string;
+    function: FunctionT$Outbound;
+};
+/** @internal */
+export declare const ToolCalls$outboundSchema: z.ZodType<ToolCalls$Outbound, z.ZodTypeDef, ToolCalls>;
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export declare namespace ToolCalls$ {
+    /** @deprecated use `ToolCalls$inboundSchema` instead. */
+    const inboundSchema: z.ZodType<ToolCalls, z.ZodTypeDef, unknown>;
+    /** @deprecated use `ToolCalls$outboundSchema` instead. */
+    const outboundSchema: z.ZodType<ToolCalls$Outbound, z.ZodTypeDef, ToolCalls>;
+    /** @deprecated use `ToolCalls$Outbound` instead. */
+    type Outbound = ToolCalls$Outbound;
+}
+export declare function toolCallsToJSON(toolCalls: ToolCalls): string;
+export declare function toolCallsFromJSON(jsonString: string): SafeParseResult<ToolCalls, SDKValidationError>;
+/** @internal */
+export declare const PrefixMessages$inboundSchema: z.ZodType<PrefixMessages, z.ZodTypeDef, unknown>;
+/** @internal */
+export type PrefixMessages$Outbound = {
+    role: string;
+    content: string | Array<One$Outbound | Two2$Outbound>;
+    tool_calls?: Array<ToolCalls$Outbound> | undefined;
+};
+/** @internal */
+export declare const PrefixMessages$outboundSchema: z.ZodType<PrefixMessages$Outbound, z.ZodTypeDef, PrefixMessages>;
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export declare namespace PrefixMessages$ {
+    /** @deprecated use `PrefixMessages$inboundSchema` instead. */
+    const inboundSchema: z.ZodType<PrefixMessages, z.ZodTypeDef, unknown>;
+    /** @deprecated use `PrefixMessages$outboundSchema` instead. */
+    const outboundSchema: z.ZodType<PrefixMessages$Outbound, z.ZodTypeDef, PrefixMessages>;
+    /** @deprecated use `PrefixMessages$Outbound` instead. */
+    type Outbound = PrefixMessages$Outbound;
+}
+export declare function prefixMessagesToJSON(prefixMessages: PrefixMessages): string;
+export declare function prefixMessagesFromJSON(jsonString: string): SafeParseResult<PrefixMessages, SDKValidationError>;
+/** @internal */
+export declare const DeploymentsRole$inboundSchema: z.ZodNativeEnum<typeof DeploymentsRole>;
+/** @internal */
+export declare const DeploymentsRole$outboundSchema: z.ZodNativeEnum<typeof DeploymentsRole>;
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export declare namespace DeploymentsRole$ {
+    /** @deprecated use `DeploymentsRole$inboundSchema` instead. */
+    const inboundSchema: z.ZodNativeEnum<{
+        readonly System: "system";
+        readonly Assistant: "assistant";
+        readonly User: "user";
+        readonly Exception: "exception";
+        readonly Tool: "tool";
+        readonly Prompt: "prompt";
+        readonly Correction: "correction";
+        readonly ExpectedOutput: "expected_output";
+    }>;
+    /** @deprecated use `DeploymentsRole$outboundSchema` instead. */
+    const outboundSchema: z.ZodNativeEnum<{
+        readonly System: "system";
+        readonly Assistant: "assistant";
+        readonly User: "user";
+        readonly Exception: "exception";
+        readonly Tool: "tool";
+        readonly Prompt: "prompt";
+        readonly Correction: "correction";
+        readonly ExpectedOutput: "expected_output";
+    }>;
+}
+/** @internal */
+export declare const Deployments2MessagesContentType$inboundSchema: z.ZodNativeEnum<typeof Deployments2MessagesContentType>;
+/** @internal */
+export declare const Deployments2MessagesContentType$outboundSchema: z.ZodNativeEnum<typeof Deployments2MessagesContentType>;
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export declare namespace Deployments2MessagesContentType$ {
+    /** @deprecated use `Deployments2MessagesContentType$inboundSchema` instead. */
+    const inboundSchema: z.ZodNativeEnum<{
+        readonly ImageUrl: "image_url";
+    }>;
+    /** @deprecated use `Deployments2MessagesContentType$outboundSchema` instead. */
+    const outboundSchema: z.ZodNativeEnum<{
+        readonly ImageUrl: "image_url";
+    }>;
+}
+/** @internal */
+export declare const TwoImageUrl$inboundSchema: z.ZodType<TwoImageUrl, z.ZodTypeDef, unknown>;
+/** @internal */
+export type TwoImageUrl$Outbound = {
+    url: string;
+    detail?: string | undefined;
+};
+/** @internal */
+export declare const TwoImageUrl$outboundSchema: z.ZodType<TwoImageUrl$Outbound, z.ZodTypeDef, TwoImageUrl>;
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export declare namespace TwoImageUrl$ {
+    /** @deprecated use `TwoImageUrl$inboundSchema` instead. */
+    const inboundSchema: z.ZodType<TwoImageUrl, z.ZodTypeDef, unknown>;
+    /** @deprecated use `TwoImageUrl$outboundSchema` instead. */
+    const outboundSchema: z.ZodType<TwoImageUrl$Outbound, z.ZodTypeDef, TwoImageUrl>;
+    /** @deprecated use `TwoImageUrl$Outbound` instead. */
+    type Outbound = TwoImageUrl$Outbound;
+}
+export declare function twoImageUrlToJSON(twoImageUrl: TwoImageUrl): string;
+export declare function twoImageUrlFromJSON(jsonString: string): SafeParseResult<TwoImageUrl, SDKValidationError>;
+/** @internal */
+export declare const Deployments22$inboundSchema: z.ZodType<Deployments22, z.ZodTypeDef, unknown>;
+/** @internal */
+export type Deployments22$Outbound = {
+    type: string;
+    image_url: TwoImageUrl$Outbound;
+};
+/** @internal */
+export declare const Deployments22$outboundSchema: z.ZodType<Deployments22$Outbound, z.ZodTypeDef, Deployments22>;
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export declare namespace Deployments22$ {
+    /** @deprecated use `Deployments22$inboundSchema` instead. */
+    const inboundSchema: z.ZodType<Deployments22, z.ZodTypeDef, unknown>;
+    /** @deprecated use `Deployments22$outboundSchema` instead. */
+    const outboundSchema: z.ZodType<Deployments22$Outbound, z.ZodTypeDef, Deployments22>;
+    /** @deprecated use `Deployments22$Outbound` instead. */
+    type Outbound = Deployments22$Outbound;
+}
+export declare function deployments22ToJSON(deployments22: Deployments22): string;
+export declare function deployments22FromJSON(jsonString: string): SafeParseResult<Deployments22, SDKValidationError>;
+/** @internal */
+export declare const Deployments2MessagesType$inboundSchema: z.ZodNativeEnum<typeof Deployments2MessagesType>;
+/** @internal */
+export declare const Deployments2MessagesType$outboundSchema: z.ZodNativeEnum<typeof Deployments2MessagesType>;
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export declare namespace Deployments2MessagesType$ {
+    /** @deprecated use `Deployments2MessagesType$inboundSchema` instead. */
+    const inboundSchema: z.ZodNativeEnum<{
+        readonly Text: "text";
+    }>;
+    /** @deprecated use `Deployments2MessagesType$outboundSchema` instead. */
+    const outboundSchema: z.ZodNativeEnum<{
+        readonly Text: "text";
+    }>;
+}
+/** @internal */
+export declare const Two1$inboundSchema: z.ZodType<Two1, z.ZodTypeDef, unknown>;
+/** @internal */
+export type Two1$Outbound = {
+    type: string;
+    text: string;
+};
+/** @internal */
+export declare const Two1$outboundSchema: z.ZodType<Two1$Outbound, z.ZodTypeDef, Two1>;
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export declare namespace Two1$ {
+    /** @deprecated use `Two1$inboundSchema` instead. */
+    const inboundSchema: z.ZodType<Two1, z.ZodTypeDef, unknown>;
+    /** @deprecated use `Two1$outboundSchema` instead. */
+    const outboundSchema: z.ZodType<Two1$Outbound, z.ZodTypeDef, Two1>;
+    /** @deprecated use `Two1$Outbound` instead. */
+    type Outbound = Two1$Outbound;
+}
+export declare function two1ToJSON(two1: Two1): string;
+export declare function two1FromJSON(jsonString: string): SafeParseResult<Two1, SDKValidationError>;
+/** @internal */
+export declare const Content2$inboundSchema: z.ZodType<Content2, z.ZodTypeDef, unknown>;
+/** @internal */
+export type Content2$Outbound = Two1$Outbound | Deployments22$Outbound;
+/** @internal */
+export declare const Content2$outboundSchema: z.ZodType<Content2$Outbound, z.ZodTypeDef, Content2>;
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export declare namespace Content2$ {
+    /** @deprecated use `Content2$inboundSchema` instead. */
+    const inboundSchema: z.ZodType<Content2, z.ZodTypeDef, unknown>;
+    /** @deprecated use `Content2$outboundSchema` instead. */
+    const outboundSchema: z.ZodType<Content2$Outbound, z.ZodTypeDef, Content2>;
+    /** @deprecated use `Content2$Outbound` instead. */
+    type Outbound = Content2$Outbound;
+}
+export declare function content2ToJSON(content2: Content2): string;
+export declare function content2FromJSON(jsonString: string): SafeParseResult<Content2, SDKValidationError>;
+/** @internal */
+export declare const DeploymentsContent$inboundSchema: z.ZodType<DeploymentsContent, z.ZodTypeDef, unknown>;
+/** @internal */
+export type DeploymentsContent$Outbound = string | Array<Two1$Outbound | Deployments22$Outbound>;
+/** @internal */
+export declare const DeploymentsContent$outboundSchema: z.ZodType<DeploymentsContent$Outbound, z.ZodTypeDef, DeploymentsContent>;
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export declare namespace DeploymentsContent$ {
+    /** @deprecated use `DeploymentsContent$inboundSchema` instead. */
+    const inboundSchema: z.ZodType<DeploymentsContent, z.ZodTypeDef, unknown>;
+    /** @deprecated use `DeploymentsContent$outboundSchema` instead. */
+    const outboundSchema: z.ZodType<DeploymentsContent$Outbound, z.ZodTypeDef, DeploymentsContent>;
+    /** @deprecated use `DeploymentsContent$Outbound` instead. */
+    type Outbound = DeploymentsContent$Outbound;
+}
+export declare function deploymentsContentToJSON(deploymentsContent: DeploymentsContent): string;
+export declare function deploymentsContentFromJSON(jsonString: string): SafeParseResult<DeploymentsContent, SDKValidationError>;
+/** @internal */
+export declare const DeploymentsType$inboundSchema: z.ZodNativeEnum<typeof DeploymentsType>;
+/** @internal */
+export declare const DeploymentsType$outboundSchema: z.ZodNativeEnum<typeof DeploymentsType>;
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export declare namespace DeploymentsType$ {
+    /** @deprecated use `DeploymentsType$inboundSchema` instead. */
+    const inboundSchema: z.ZodNativeEnum<{
+        readonly Function: "function";
+    }>;
+    /** @deprecated use `DeploymentsType$outboundSchema` instead. */
+    const outboundSchema: z.ZodNativeEnum<{
+        readonly Function: "function";
+    }>;
+}
+/** @internal */
+export declare const DeploymentsFunction$inboundSchema: z.ZodType<DeploymentsFunction, z.ZodTypeDef, unknown>;
+/** @internal */
+export type DeploymentsFunction$Outbound = {
+    name: string;
+    arguments: string;
+};
+/** @internal */
+export declare const DeploymentsFunction$outboundSchema: z.ZodType<DeploymentsFunction$Outbound, z.ZodTypeDef, DeploymentsFunction>;
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export declare namespace DeploymentsFunction$ {
+    /** @deprecated use `DeploymentsFunction$inboundSchema` instead. */
+    const inboundSchema: z.ZodType<DeploymentsFunction, z.ZodTypeDef, unknown>;
+    /** @deprecated use `DeploymentsFunction$outboundSchema` instead. */
+    const outboundSchema: z.ZodType<DeploymentsFunction$Outbound, z.ZodTypeDef, DeploymentsFunction>;
+    /** @deprecated use `DeploymentsFunction$Outbound` instead. */
+    type Outbound = DeploymentsFunction$Outbound;
+}
+export declare function deploymentsFunctionToJSON(deploymentsFunction: DeploymentsFunction): string;
+export declare function deploymentsFunctionFromJSON(jsonString: string): SafeParseResult<DeploymentsFunction, SDKValidationError>;
+/** @internal */
+export declare const DeploymentsToolCalls$inboundSchema: z.ZodType<DeploymentsToolCalls, z.ZodTypeDef, unknown>;
+/** @internal */
+export type DeploymentsToolCalls$Outbound = {
+    id?: string | undefined;
+    index?: number | undefined;
+    type: string;
+    function: DeploymentsFunction$Outbound;
+};
+/** @internal */
+export declare const DeploymentsToolCalls$outboundSchema: z.ZodType<DeploymentsToolCalls$Outbound, z.ZodTypeDef, DeploymentsToolCalls>;
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export declare namespace DeploymentsToolCalls$ {
+    /** @deprecated use `DeploymentsToolCalls$inboundSchema` instead. */
+    const inboundSchema: z.ZodType<DeploymentsToolCalls, z.ZodTypeDef, unknown>;
+    /** @deprecated use `DeploymentsToolCalls$outboundSchema` instead. */
+    const outboundSchema: z.ZodType<DeploymentsToolCalls$Outbound, z.ZodTypeDef, DeploymentsToolCalls>;
+    /** @deprecated use `DeploymentsToolCalls$Outbound` instead. */
+    type Outbound = DeploymentsToolCalls$Outbound;
+}
+export declare function deploymentsToolCallsToJSON(deploymentsToolCalls: DeploymentsToolCalls): string;
+export declare function deploymentsToolCallsFromJSON(jsonString: string): SafeParseResult<DeploymentsToolCalls, SDKValidationError>;
+/** @internal */
+export declare const Messages$inboundSchema: z.ZodType<Messages, z.ZodTypeDef, unknown>;
+/** @internal */
+export type Messages$Outbound = {
+    role: string;
+    content: string | Array<Two1$Outbound | Deployments22$Outbound>;
+    tool_calls?: Array<DeploymentsToolCalls$Outbound> | undefined;
+};
+/** @internal */
+export declare const Messages$outboundSchema: z.ZodType<Messages$Outbound, z.ZodTypeDef, Messages>;
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export declare namespace Messages$ {
+    /** @deprecated use `Messages$inboundSchema` instead. */
+    const inboundSchema: z.ZodType<Messages, z.ZodTypeDef, unknown>;
+    /** @deprecated use `Messages$outboundSchema` instead. */
+    const outboundSchema: z.ZodType<Messages$Outbound, z.ZodTypeDef, Messages>;
+    /** @deprecated use `Messages$Outbound` instead. */
+    type Outbound = Messages$Outbound;
+}
+export declare function messagesToJSON(messages: Messages): string;
+export declare function messagesFromJSON(jsonString: string): SafeParseResult<Messages, SDKValidationError>;
+/** @internal */
+export declare const Metadata$inboundSchema: z.ZodType<Metadata, z.ZodTypeDef, unknown>;
+/** @internal */
+export type Metadata$Outbound = {
+    file_name?: string | undefined;
+    file_type?: string | undefined;
+    page_number?: number | undefined;
+};
+/** @internal */
+export declare const Metadata$outboundSchema: z.ZodType<Metadata$Outbound, z.ZodTypeDef, Metadata>;
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export declare namespace Metadata$ {
+    /** @deprecated use `Metadata$inboundSchema` instead. */
+    const inboundSchema: z.ZodType<Metadata, z.ZodTypeDef, unknown>;
+    /** @deprecated use `Metadata$outboundSchema` instead. */
+    const outboundSchema: z.ZodType<Metadata$Outbound, z.ZodTypeDef, Metadata>;
+    /** @deprecated use `Metadata$Outbound` instead. */
+    type Outbound = Metadata$Outbound;
+}
+export declare function metadataToJSON(metadata: Metadata): string;
+export declare function metadataFromJSON(jsonString: string): SafeParseResult<Metadata, SDKValidationError>;
+/** @internal */
+export declare const Documents$inboundSchema: z.ZodType<Documents, z.ZodTypeDef, unknown>;
+/** @internal */
+export type Documents$Outbound = {
+    text: string;
+    metadata?: Metadata$Outbound | undefined;
+};
+/** @internal */
+export declare const Documents$outboundSchema: z.ZodType<Documents$Outbound, z.ZodTypeDef, Documents>;
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export declare namespace Documents$ {
+    /** @deprecated use `Documents$inboundSchema` instead. */
+    const inboundSchema: z.ZodType<Documents, z.ZodTypeDef, unknown>;
+    /** @deprecated use `Documents$outboundSchema` instead. */
+    const outboundSchema: z.ZodType<Documents$Outbound, z.ZodTypeDef, Documents>;
+    /** @deprecated use `Documents$Outbound` instead. */
+    type Outbound = Documents$Outbound;
+}
+export declare function documentsToJSON(documents: Documents): string;
+export declare function documentsFromJSON(jsonString: string): SafeParseResult<Documents, SDKValidationError>;
+/** @internal */
+export declare const InvokeOptions$inboundSchema: z.ZodType<InvokeOptions, z.ZodTypeDef, unknown>;
+/** @internal */
+export type InvokeOptions$Outbound = {
+    include_retrievals: boolean;
+};
+/** @internal */
+export declare const InvokeOptions$outboundSchema: z.ZodType<InvokeOptions$Outbound, z.ZodTypeDef, InvokeOptions>;
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export declare namespace InvokeOptions$ {
+    /** @deprecated use `InvokeOptions$inboundSchema` instead. */
+    const inboundSchema: z.ZodType<InvokeOptions, z.ZodTypeDef, unknown>;
+    /** @deprecated use `InvokeOptions$outboundSchema` instead. */
+    const outboundSchema: z.ZodType<InvokeOptions$Outbound, z.ZodTypeDef, InvokeOptions>;
+    /** @deprecated use `InvokeOptions$Outbound` instead. */
+    type Outbound = InvokeOptions$Outbound;
+}
+export declare function invokeOptionsToJSON(invokeOptions: InvokeOptions): string;
+export declare function invokeOptionsFromJSON(jsonString: string): SafeParseResult<InvokeOptions, SDKValidationError>;
+/** @internal */
+export declare const Deployments$inboundSchema: z.ZodType<Deployments, z.ZodTypeDef, unknown>;
+/** @internal */
+export type Deployments$Outbound = {
+    key: string;
+    stream: boolean;
+    inputs?: {
+        [k: string]: string | number | boolean;
+    } | undefined;
+    context?: {
+        [k: string]: any;
+    } | undefined;
+    prefix_messages?: Array<PrefixMessages$Outbound> | undefined;
+    messages?: Array<Messages$Outbound> | undefined;
+    file_ids?: Array<string> | undefined;
+    metadata?: {
+        [k: string]: any;
+    } | undefined;
+    extra_params?: {
+        [k: string]: any;
+    } | undefined;
+    documents?: Array<Documents$Outbound> | undefined;
+    invoke_options?: InvokeOptions$Outbound | undefined;
+};
+/** @internal */
+export declare const Deployments$outboundSchema: z.ZodType<Deployments$Outbound, z.ZodTypeDef, Deployments>;
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export declare namespace Deployments$ {
+    /** @deprecated use `Deployments$inboundSchema` instead. */
+    const inboundSchema: z.ZodType<Deployments, z.ZodTypeDef, unknown>;
+    /** @deprecated use `Deployments$outboundSchema` instead. */
+    const outboundSchema: z.ZodType<Deployments$Outbound, z.ZodTypeDef, Deployments>;
+    /** @deprecated use `Deployments$Outbound` instead. */
+    type Outbound = Deployments$Outbound;
+}
+export declare function deploymentsToJSON(deployments: Deployments): string;
+export declare function deploymentsFromJSON(jsonString: string): SafeParseResult<Deployments, SDKValidationError>;
+//# sourceMappingURL=deployments.d.ts.map