Heroku LangChain - v0.2.1
    Preparing search index...

    Interface StructuredOutputMethodParams<RunOutput, IncludeRaw>

    Parameters for configuring structured output with schema and options.

    StructuredOutputMethodParams

    interface StructuredOutputMethodParams<
        RunOutput extends Record<string, any> = Record<string, any>,
        IncludeRaw extends boolean = false,
    > {
        schema: Record<string, any> | ZodType<RunOutput, ZodTypeDef, RunOutput>;
        name?: string;
        description?: string;
        method?: "functionCalling" | "jsonMode";
        includeRaw?: IncludeRaw;
    }

    Type Parameters

    • RunOutput extends Record<string, any> = Record<string, any>

      The expected output type from the structured response

    • IncludeRaw extends boolean = false

      Whether to include raw response alongside parsed output

    Index

    Properties

    schema name? description? method? includeRaw?

    Properties

    schema: Record<string, any> | ZodType<RunOutput, ZodTypeDef, RunOutput>

    The Zod schema or JSON schema object defining the expected output structure

    name?: string

    Optional name for the structured output function

    description?: string

    Optional description for the structured output function

    method?: "functionCalling" | "jsonMode"

    Method to use for structured output - either function calling or JSON mode

    includeRaw?: IncludeRaw

    Whether to include the raw response alongside the parsed output

    Settings

    Member Visibility

    On This Page

    Properties