Variable conversationSchemaConst

conversationSchema: ZodObject<{
    callableFunctions: ZodOptional<ZodObject<{
        functions: ZodOptional<ZodArray<ZodObject<{
            description: ZodOptional<ZodString>;
            id: ZodOptional<ZodString>;
            name: ZodString;
            parameters: ZodOptional<ZodObject<{
                $comment: ZodOptional<ZodString>;
                additionalProperties: ZodOptional<ZodUnion<[ZodBoolean, ZodType<JsonSchema, ZodTypeDef, JsonSchema>]>>;
                default: ZodOptional<ZodAny>;
                deprecated: ZodOptional<ZodBoolean>;
                description: ZodOptional<ZodString>;
                examples: ZodOptional<ZodArray<ZodAny, "many">>;
                maxProperties: ZodOptional<ZodNumber>;
                minProperties: ZodOptional<ZodNumber>;
                patternProperties: ZodOptional<ZodRecord<ZodString, ZodType<JsonSchema, ZodTypeDef, JsonSchema>>>;
                properties: ZodOptional<ZodRecord<ZodString, ZodType<JsonSchema, ZodTypeDef, JsonSchema>>>;
                readOnly: ZodOptional<ZodBoolean>;
                required: ZodOptional<ZodArray<ZodString, "many">>;
                title: ZodOptional<ZodString>;
                type: ZodLiteral<"object">;
                unevaluatedProperties: ZodOptional<ZodBoolean>;
                writeOnly: ZodOptional<ZodBoolean>;
            }, "strip", ZodTypeAny, {
                $comment?: string;
                additionalProperties?: boolean | JsonSchema;
                default?: any;
                deprecated?: boolean;
                description?: string;
                examples?: any[];
                maxProperties?: number;
                minProperties?: number;
                patternProperties?: Record<string, JsonSchema>;
                properties?: Record<string, JsonSchema>;
                readOnly?: boolean;
                required?: string[];
                title?: string;
                type: "object";
                unevaluatedProperties?: boolean;
                writeOnly?: boolean;
            }, {
                $comment?: string;
                additionalProperties?: boolean | JsonSchema;
                default?: any;
                deprecated?: boolean;
                description?: string;
                examples?: any[];
                maxProperties?: number;
                minProperties?: number;
                patternProperties?: Record<string, JsonSchema>;
                properties?: Record<string, JsonSchema>;
                readOnly?: boolean;
                required?: string[];
                title?: string;
                type: "object";
                unevaluatedProperties?: boolean;
                writeOnly?: boolean;
            }>>;
        }, "strip", ZodTypeAny, {
            description?: string;
            id?: string;
            name: string;
            parameters?: {
                $comment?: string;
                additionalProperties?: boolean | JsonSchema;
                default?: any;
                deprecated?: boolean;
                description?: string;
                examples?: any[];
                maxProperties?: number;
                minProperties?: number;
                patternProperties?: Record<string, JsonSchema>;
                properties?: Record<string, JsonSchema>;
                readOnly?: boolean;
                required?: string[];
                title?: string;
                type: "object";
                unevaluatedProperties?: boolean;
                writeOnly?: boolean;
            };
        }, {
            description?: string;
            id?: string;
            name: string;
            parameters?: {
                $comment?: string;
                additionalProperties?: boolean | JsonSchema;
                default?: any;
                deprecated?: boolean;
                description?: string;
                examples?: any[];
                maxProperties?: number;
                minProperties?: number;
                patternProperties?: Record<string, JsonSchema>;
                properties?: Record<string, JsonSchema>;
                readOnly?: boolean;
                required?: string[];
                title?: string;
                type: "object";
                unevaluatedProperties?: boolean;
                writeOnly?: boolean;
            };
        }>, "many">>;
    }, "strip", ZodTypeAny, {
        functions?: ({ name: string; id?: string | undefined; description?: string | undefined; parameters?: { type: "object"; title?: string | undefined; description?: string | undefined; default?: any; examples?: any[] | undefined; ... 10 more ...; additionalProperties?: boolean | ... 1 more ... | undefined; } | undefined; })[];
    }, {
        functions?: ({ name: string; id?: string | undefined; description?: string | undefined; parameters?: { type: "object"; title?: string | undefined; description?: string | undefined; default?: any; examples?: any[] | undefined; ... 10 more ...; additionalProperties?: boolean | ... 1 more ... | undefined; } | undefined; })[];
    }>>;
    config: ZodOptional<ZodObject<{
        apiKey: ZodOptional<ZodOptional<ZodString>>;
        context: ZodOptional<ZodString>;
        disableModeration: ZodOptional<ZodUnion<[ZodBoolean, ZodLiteral<"soft">]>>;
        dry: ZodOptional<ZodBoolean>;
        frequency_penalty: ZodOptional<ZodNumber>;
        function_call: ZodOptional<ZodUnion<[ZodLiteral<"none">, ZodLiteral<"auto">, ZodObject<{
            name: ZodString;
        }, "strip", ZodTypeAny, {
            name: string;
        }, {
            name: string;
        }>]>>;
        logit_bias: ZodOptional<ZodRecord<ZodEffects<ZodString, string, string>, ZodNumber>>;
        max_tokens: ZodOptional<ZodNumber>;
        model: ZodOptional<ZodString>;
        presence_penalty: ZodOptional<ZodNumber>;
        stop: ZodOptional<ZodUnion<[ZodUnion<[ZodString, ZodArray<ZodString, "many">]>, ZodNull]>>;
        stream: ZodOptional<ZodBoolean>;
        temperature: ZodOptional<ZodNumber>;
        top_p: ZodOptional<ZodNumber>;
        user: ZodOptional<ZodString>;
    }, "strip", ZodTypeAny, {
        apiKey?: string;
        context?: string;
        disableModeration?: boolean | "soft";
        dry?: boolean;
        frequency_penalty?: number;
        function_call?: "none" | "auto" | ({ name: string; });
        logit_bias?: Record<string, number>;
        max_tokens?: number;
        model?: string;
        presence_penalty?: number;
        stop?: null | string | string[];
        stream?: boolean;
        temperature?: number;
        top_p?: number;
        user?: string;
    }, {
        apiKey?: string;
        context?: string;
        disableModeration?: boolean | "soft";
        dry?: boolean;
        frequency_penalty?: number;
        function_call?: "none" | "auto" | ({ name: string; });
        logit_bias?: Record<string, number>;
        max_tokens?: number;
        model?: string;
        presence_penalty?: number;
        stop?: null | string | string[];
        stream?: boolean;
        temperature?: number;
        top_p?: number;
        user?: string;
    }>>;
    history: ZodOptional<ZodObject<{
        messages: ZodOptional<ZodArray<ZodObject<{
            content: ZodNullable<ZodString>;
            flags: ZodOptional<ZodUnion<[ZodArray<ZodString, "many">, ZodNull]>>;
            function_call: ZodOptional<ZodObject<{
                arguments: ZodRecord<ZodString, ZodAny>;
                name: ZodString;
            }, "strip", ZodTypeAny, {
                arguments: Record<string, any>;
                name: string;
            }, {
                arguments: Record<string, any>;
                name: string;
            }>>;
            id: ZodOptional<ZodString>;
            model: ZodOptional<ZodString>;
            name: ZodOptional<ZodString>;
            role: ZodUnion<[ZodLiteral<"user">, ZodLiteral<"assistant">, ZodLiteral<"system">, ZodLiteral<"function">]>;
        }, "strip", ZodTypeAny, {
            content: null | string;
            flags?: null | string[];
            function_call?: { name: string; arguments: Record<string, any>; };
            id?: string;
            model?: string;
            name?: string;
            role: "function" | "user" | "assistant" | "system";
        }, {
            content: null | string;
            flags?: null | string[];
            function_call?: { name: string; arguments: Record<string, any>; };
            id?: string;
            model?: string;
            name?: string;
            role: "function" | "user" | "assistant" | "system";
        }>, "many">>;
    }, "strip", ZodTypeAny, {
        messages?: ({ role: "function" | "user" | "assistant" | "system"; content: string | null; id?: string | undefined; name?: string | undefined; function_call?: { name: string; arguments: Record<string, any>; } | undefined; model?: string | undefined; flags?: string[] | ... 1 more ... | undefined; })[];
    }, {
        messages?: ({ role: "function" | "user" | "assistant" | "system"; content: string | null; id?: string | undefined; name?: string | undefined; function_call?: { name: string; arguments: Record<string, any>; } | undefined; model?: string | undefined; flags?: string[] | ... 1 more ... | undefined; })[];
    }>>;
    id: ZodOptional<ZodString>;
    pluginsData: ZodOptional<ZodRecord<ZodString, ZodAny>>;
    requestOptions: ZodOptional<ZodObject<{
        headers: ZodOptional<ZodRecord<ZodString, ZodString>>;
        proxy: ZodOptional<ZodObject<{
            auth: ZodOptional<ZodObject<{
                password: ZodString;
                username: ZodString;
            }, "strip", ZodTypeAny, {
                password: string;
                username: string;
            }, {
                password: string;
                username: string;
            }>>;
            host: ZodString;
            port: ZodOptional<ZodNumber>;
            protocol: ZodOptional<ZodEnum<["http", "https"]>>;
        }, "strip", ZodTypeAny, {
            auth?: { username: string; password: string; };
            host: string;
            port?: number;
            protocol?: "http" | "https";
        }, {
            auth?: { username: string; password: string; };
            host: string;
            port?: number;
            protocol?: "http" | "https";
        }>>;
    }, "strip", ZodTypeAny, {
        headers?: Record<string, string>;
        proxy?: { host: string; port?: number | undefined; protocol?: "http" | "https" | undefined; auth?: { username: string; password: string; } | undefined; };
    }, {
        headers?: Record<string, string>;
        proxy?: { host: string; port?: number | undefined; protocol?: "http" | "https" | undefined; auth?: { username: string; password: string; } | undefined; };
    }>>;
}, "strip", ZodTypeAny, {
    callableFunctions?: { functions?: { name: string; id?: string | undefined; description?: string | undefined; parameters?: { type: "object"; title?: string | undefined; description?: string | undefined; default?: any; ... 11 more ...; additionalProperties?: boolean | ... 1 more ... | undefined; } | undefined; }[] | undefined; };
    config?: { context?: string | undefined; dry?: boolean | undefined; disableModeration?: boolean | "soft" | undefined; apiKey?: string | undefined; model?: string | undefined; temperature?: number | undefined; ... 8 more ...; function_call?: "none" | ... 2 more ... | undefined; };
    history?: { messages?: { role: "function" | "user" | "assistant" | "system"; content: string | null; id?: string | undefined; name?: string | undefined; function_call?: { name: string; arguments: Record<...>; } | undefined; model?: string | undefined; flags?: string[] | ... 1 more ... | undefined; }[] | undefined; };
    id?: string;
    pluginsData?: Record<string, any>;
    requestOptions?: { headers?: Record<string, string> | undefined; proxy?: { host: string; port?: number | undefined; protocol?: "http" | "https" | undefined; auth?: { username: string; password: string; } | undefined; } | undefined; };
}, {
    callableFunctions?: { functions?: { name: string; id?: string | undefined; description?: string | undefined; parameters?: { type: "object"; title?: string | undefined; description?: string | undefined; default?: any; ... 11 more ...; additionalProperties?: boolean | ... 1 more ... | undefined; } | undefined; }[] | undefined; };
    config?: { context?: string | undefined; dry?: boolean | undefined; disableModeration?: boolean | "soft" | undefined; apiKey?: string | undefined; model?: string | undefined; temperature?: number | undefined; ... 8 more ...; function_call?: "none" | ... 2 more ... | undefined; };
    history?: { messages?: { role: "function" | "user" | "assistant" | "system"; content: string | null; id?: string | undefined; name?: string | undefined; function_call?: { name: string; arguments: Record<...>; } | undefined; model?: string | undefined; flags?: string[] | ... 1 more ... | undefined; }[] | undefined; };
    id?: string;
    pluginsData?: Record<string, any>;
    requestOptions?: { headers?: Record<string, string> | undefined; proxy?: { host: string; port?: number | undefined; protocol?: "http" | "https" | undefined; auth?: { username: string; password: string; } | undefined; } | undefined; };
}> = ...

A JSON representation of a Conversation instance.

Type declaration

  • callableFunctions: ZodOptional<ZodObject<{
        functions: ZodOptional<ZodArray<ZodObject<{
            description: ZodOptional<ZodString>;
            id: ZodOptional<ZodString>;
            name: ZodString;
            parameters: ZodOptional<ZodObject<{
                $comment: ZodOptional<ZodString>;
                additionalProperties: ZodOptional<ZodUnion<[ZodBoolean, ZodType<JsonSchema, ZodTypeDef, JsonSchema>]>>;
                default: ZodOptional<ZodAny>;
                deprecated: ZodOptional<ZodBoolean>;
                description: ZodOptional<ZodString>;
                examples: ZodOptional<ZodArray<ZodAny, "many">>;
                maxProperties: ZodOptional<ZodNumber>;
                minProperties: ZodOptional<ZodNumber>;
                patternProperties: ZodOptional<ZodRecord<ZodString, ZodType<JsonSchema, ZodTypeDef, JsonSchema>>>;
                properties: ZodOptional<ZodRecord<ZodString, ZodType<JsonSchema, ZodTypeDef, JsonSchema>>>;
                readOnly: ZodOptional<ZodBoolean>;
                required: ZodOptional<ZodArray<ZodString, "many">>;
                title: ZodOptional<ZodString>;
                type: ZodLiteral<"object">;
                unevaluatedProperties: ZodOptional<ZodBoolean>;
                writeOnly: ZodOptional<ZodBoolean>;
            }, "strip", ZodTypeAny, {
                $comment?: string;
                additionalProperties?: boolean | JsonSchema;
                default?: any;
                deprecated?: boolean;
                description?: string;
                examples?: any[];
                maxProperties?: number;
                minProperties?: number;
                patternProperties?: Record<string, JsonSchema>;
                properties?: Record<string, JsonSchema>;
                readOnly?: boolean;
                required?: string[];
                title?: string;
                type: "object";
                unevaluatedProperties?: boolean;
                writeOnly?: boolean;
            }, {
                $comment?: string;
                additionalProperties?: boolean | JsonSchema;
                default?: any;
                deprecated?: boolean;
                description?: string;
                examples?: any[];
                maxProperties?: number;
                minProperties?: number;
                patternProperties?: Record<string, JsonSchema>;
                properties?: Record<string, JsonSchema>;
                readOnly?: boolean;
                required?: string[];
                title?: string;
                type: "object";
                unevaluatedProperties?: boolean;
                writeOnly?: boolean;
            }>>;
        }, "strip", ZodTypeAny, {
            description?: string;
            id?: string;
            name: string;
            parameters?: {
                $comment?: string;
                additionalProperties?: boolean | JsonSchema;
                default?: any;
                deprecated?: boolean;
                description?: string;
                examples?: any[];
                maxProperties?: number;
                minProperties?: number;
                patternProperties?: Record<string, JsonSchema>;
                properties?: Record<string, JsonSchema>;
                readOnly?: boolean;
                required?: string[];
                title?: string;
                type: "object";
                unevaluatedProperties?: boolean;
                writeOnly?: boolean;
            };
        }, {
            description?: string;
            id?: string;
            name: string;
            parameters?: {
                $comment?: string;
                additionalProperties?: boolean | JsonSchema;
                default?: any;
                deprecated?: boolean;
                description?: string;
                examples?: any[];
                maxProperties?: number;
                minProperties?: number;
                patternProperties?: Record<string, JsonSchema>;
                properties?: Record<string, JsonSchema>;
                readOnly?: boolean;
                required?: string[];
                title?: string;
                type: "object";
                unevaluatedProperties?: boolean;
                writeOnly?: boolean;
            };
        }>, "many">>;
    }, "strip", ZodTypeAny, {
        functions?: ({ name: string; id?: string | undefined; description?: string | undefined; parameters?: { type: "object"; title?: string | undefined; description?: string | undefined; default?: any; examples?: any[] | undefined; ... 10 more ...; additionalProperties?: boolean | ... 1 more ... | undefined; } | undefined; })[];
    }, {
        functions?: ({ name: string; id?: string | undefined; description?: string | undefined; parameters?: { type: "object"; title?: string | undefined; description?: string | undefined; default?: any; examples?: any[] | undefined; ... 10 more ...; additionalProperties?: boolean | ... 1 more ... | undefined; } | undefined; })[];
    }>>
  • config: ZodOptional<ZodObject<{
        apiKey: ZodOptional<ZodOptional<ZodString>>;
        context: ZodOptional<ZodString>;
        disableModeration: ZodOptional<ZodUnion<[ZodBoolean, ZodLiteral<"soft">]>>;
        dry: ZodOptional<ZodBoolean>;
        frequency_penalty: ZodOptional<ZodNumber>;
        function_call: ZodOptional<ZodUnion<[ZodLiteral<"none">, ZodLiteral<"auto">, ZodObject<{
            name: ZodString;
        }, "strip", ZodTypeAny, {
            name: string;
        }, {
            name: string;
        }>]>>;
        logit_bias: ZodOptional<ZodRecord<ZodEffects<ZodString, string, string>, ZodNumber>>;
        max_tokens: ZodOptional<ZodNumber>;
        model: ZodOptional<ZodString>;
        presence_penalty: ZodOptional<ZodNumber>;
        stop: ZodOptional<ZodUnion<[ZodUnion<[ZodString, ZodArray<ZodString, "many">]>, ZodNull]>>;
        stream: ZodOptional<ZodBoolean>;
        temperature: ZodOptional<ZodNumber>;
        top_p: ZodOptional<ZodNumber>;
        user: ZodOptional<ZodString>;
    }, "strip", ZodTypeAny, {
        apiKey?: string;
        context?: string;
        disableModeration?: boolean | "soft";
        dry?: boolean;
        frequency_penalty?: number;
        function_call?: "none" | "auto" | ({ name: string; });
        logit_bias?: Record<string, number>;
        max_tokens?: number;
        model?: string;
        presence_penalty?: number;
        stop?: null | string | string[];
        stream?: boolean;
        temperature?: number;
        top_p?: number;
        user?: string;
    }, {
        apiKey?: string;
        context?: string;
        disableModeration?: boolean | "soft";
        dry?: boolean;
        frequency_penalty?: number;
        function_call?: "none" | "auto" | ({ name: string; });
        logit_bias?: Record<string, number>;
        max_tokens?: number;
        model?: string;
        presence_penalty?: number;
        stop?: null | string | string[];
        stream?: boolean;
        temperature?: number;
        top_p?: number;
        user?: string;
    }>>
  • history: ZodOptional<ZodObject<{
        messages: ZodOptional<ZodArray<ZodObject<{
            content: ZodNullable<ZodString>;
            flags: ZodOptional<ZodUnion<[ZodArray<ZodString, "many">, ZodNull]>>;
            function_call: ZodOptional<ZodObject<{
                arguments: ZodRecord<ZodString, ZodAny>;
                name: ZodString;
            }, "strip", ZodTypeAny, {
                arguments: Record<string, any>;
                name: string;
            }, {
                arguments: Record<string, any>;
                name: string;
            }>>;
            id: ZodOptional<ZodString>;
            model: ZodOptional<ZodString>;
            name: ZodOptional<ZodString>;
            role: ZodUnion<[ZodLiteral<"user">, ZodLiteral<"assistant">, ZodLiteral<"system">, ZodLiteral<"function">]>;
        }, "strip", ZodTypeAny, {
            content: null | string;
            flags?: null | string[];
            function_call?: { name: string; arguments: Record<string, any>; };
            id?: string;
            model?: string;
            name?: string;
            role: "function" | "user" | "assistant" | "system";
        }, {
            content: null | string;
            flags?: null | string[];
            function_call?: { name: string; arguments: Record<string, any>; };
            id?: string;
            model?: string;
            name?: string;
            role: "function" | "user" | "assistant" | "system";
        }>, "many">>;
    }, "strip", ZodTypeAny, {
        messages?: ({ role: "function" | "user" | "assistant" | "system"; content: string | null; id?: string | undefined; name?: string | undefined; function_call?: { name: string; arguments: Record<string, any>; } | undefined; model?: string | undefined; flags?: string[] | ... 1 more ... | undefined; })[];
    }, {
        messages?: ({ role: "function" | "user" | "assistant" | "system"; content: string | null; id?: string | undefined; name?: string | undefined; function_call?: { name: string; arguments: Record<string, any>; } | undefined; model?: string | undefined; flags?: string[] | ... 1 more ... | undefined; })[];
    }>>
  • id: ZodOptional<ZodString>
  • pluginsData: ZodOptional<ZodRecord<ZodString, ZodAny>>
  • requestOptions: ZodOptional<ZodObject<{
        headers: ZodOptional<ZodRecord<ZodString, ZodString>>;
        proxy: ZodOptional<ZodObject<{
            auth: ZodOptional<ZodObject<{
                password: ZodString;
                username: ZodString;
            }, "strip", ZodTypeAny, {
                password: string;
                username: string;
            }, {
                password: string;
                username: string;
            }>>;
            host: ZodString;
            port: ZodOptional<ZodNumber>;
            protocol: ZodOptional<ZodEnum<["http", "https"]>>;
        }, "strip", ZodTypeAny, {
            auth?: { username: string; password: string; };
            host: string;
            port?: number;
            protocol?: "http" | "https";
        }, {
            auth?: { username: string; password: string; };
            host: string;
            port?: number;
            protocol?: "http" | "https";
        }>>;
    }, "strip", ZodTypeAny, {
        headers?: Record<string, string>;
        proxy?: { host: string; port?: number | undefined; protocol?: "http" | "https" | undefined; auth?: { username: string; password: string; } | undefined; };
    }, {
        headers?: Record<string, string>;
        proxy?: { host: string; port?: number | undefined; protocol?: "http" | "https" | undefined; auth?: { username: string; password: string; } | undefined; };
    }>>

Type declaration

  • Optional callableFunctions?: { functions?: { name: string; id?: string | undefined; description?: string | undefined; parameters?: { type: "object"; title?: string | undefined; description?: string | undefined; default?: any; ... 11 more ...; additionalProperties?: boolean | ... 1 more ... | undefined; } | undefined; }[] | undefined; }
  • Optional config?: { context?: string | undefined; dry?: boolean | undefined; disableModeration?: boolean | "soft" | undefined; apiKey?: string | undefined; model?: string | undefined; temperature?: number | undefined; ... 8 more ...; function_call?: "none" | ... 2 more ... | undefined; }
  • Optional history?: { messages?: { role: "function" | "user" | "assistant" | "system"; content: string | null; id?: string | undefined; name?: string | undefined; function_call?: { name: string; arguments: Record<...>; } | undefined; model?: string | undefined; flags?: string[] | ... 1 more ... | undefined; }[] | undefined; }
  • Optional id?: string
  • Optional pluginsData?: Record<string, any>
  • Optional requestOptions?: { headers?: Record<string, string> | undefined; proxy?: { host: string; port?: number | undefined; protocol?: "http" | "https" | undefined; auth?: { username: string; password: string; } | undefined; } | undefined; }

Type declaration

  • Optional callableFunctions?: { functions?: { name: string; id?: string | undefined; description?: string | undefined; parameters?: { type: "object"; title?: string | undefined; description?: string | undefined; default?: any; ... 11 more ...; additionalProperties?: boolean | ... 1 more ... | undefined; } | undefined; }[] | undefined; }
  • Optional config?: { context?: string | undefined; dry?: boolean | undefined; disableModeration?: boolean | "soft" | undefined; apiKey?: string | undefined; model?: string | undefined; temperature?: number | undefined; ... 8 more ...; function_call?: "none" | ... 2 more ... | undefined; }
  • Optional history?: { messages?: { role: "function" | "user" | "assistant" | "system"; content: string | null; id?: string | undefined; name?: string | undefined; function_call?: { name: string; arguments: Record<...>; } | undefined; model?: string | undefined; flags?: string[] | ... 1 more ... | undefined; }[] | undefined; }
  • Optional id?: string
  • Optional pluginsData?: Record<string, any>
  • Optional requestOptions?: { headers?: Record<string, string> | undefined; proxy?: { host: string; port?: number | undefined; protocol?: "http" | "https" | undefined; auth?: { username: string; password: string; } | undefined; } | undefined; }

Generated using TypeDoc