Type Alias CreateStructuredOutputRunnableConfig<RunInput, RunOutput>

Configuration params for the createStructuredOutputRunnable method.

type CreateStructuredOutputRunnableConfig<
    RunInput extends Record<string, any>,
    RunOutput,
> = {
    llm: BaseMessage<BaseMessage, BaseMessage, BaseMessage>;
    outputParser?: BaseMessage<RunOutput>;
    outputSchema: BaseMessage | BaseMessage;
    prompt: BaseMessage<BaseMessage<Extract<keyof RunInput, string>>>;
}

Type Parameters

RunInput extends Record<string, any>
RunOutput

Index

Properties

llm outputParser? outputSchema prompt

Properties

llm

llm: BaseMessage<BaseMessage, BaseMessage, BaseMessage>

Language model to use, assumed to support the OpenAI function-calling API.

`Optional`outputParser

outputParser?: BaseMessage<RunOutput>

BaseLLMOutputParser to use for parsing model outputs.

outputSchema

outputSchema: BaseMessage | BaseMessage

Schema to output. Must be either valid JSONSchema or a Zod schema.

prompt

prompt: BaseMessage<BaseMessage<Extract<keyof RunInput, string>>>

BasePromptTemplate to pass to the model.