Heroku LangChain.js - v1.0.1
    Preparing search index...

    Interface ChatHerokuCallOptions

    Interface for the options that can be passed at runtime to ChatHeroku methods. Extends BaseChatModelCallOptions and includes Heroku-specific tool parameters.

    interface ChatHerokuCallOptions {
        tools?: (
            StructuredTool<ToolInputSchemaBase, any, any, any>
            | HerokuFunctionTool
        )[];
        tool_choice?:
            | "auto"
            | "any"
            | "none"
            | "required"
            | { type: "function"; function: { name: string } };
        additionalKwargs?: Record<string, any>;
        temperature?: number;
        maxTokens?: number;
        topP?: number;
        stop?: string[];
    }

    Hierarchy

    • BaseChatModelCallOptions
      • ChatHerokuCallOptions
    Index

    Properties

    tools? tool_choice? additionalKwargs? temperature? maxTokens? topP? stop?

    Properties

    tools?: (
        StructuredTool<ToolInputSchemaBase, any, any, any>
        | HerokuFunctionTool
    )[]

    A list of tools the model may call. LangChain StructuredTool definitions are converted to Heroku's function tool format. See: https://devcenter.heroku.com/articles/heroku-inference-api-v1-chat-completions#tools-array-function-type-tools

    tool_choice?:
        | "auto"
        | "any"
        | "none"
        | "required"
        | { type: "function"; function: { name: string } }

    Controls how the model uses tools. Can be "auto", "required", "any" (converted to "required"), or an object specifying a particular function to call. Note: LangChain may pass "any" which will be automatically converted to "required" for the Heroku API. See: https://devcenter.heroku.com/articles/heroku-inference-api-v1-chat-completions#tool_choice-parameter

    additionalKwargs?: Record<string, any>

    Allows passing other Heroku-specific parameters not explicitly defined (e.g., extended_thinking) at runtime.

    temperature?: number
    maxTokens?: number
    topP?: number
    stop?: string[]

    Stop tokens to use for this call. If not provided, the default stop tokens for the model will be used.

    Settings

    Member Visibility

    On This Page

    Properties