Interface ChatCerebrasCallOptions

interface ChatCerebrasCallOptions {
    callbacks?: Callbacks;
    configurable?: Record<string, any>;
    headers?: Headers;
    httpAgent?: any;
    ls_structured_output_format?: {
        kwargs: {
            method: string;
        };
        schema?: JsonSchema7Type;
    };
    maxConcurrency?: number;
    metadata?: Record<string, unknown>;
    recursionLimit?: number;
    response_format?: null | ResponseFormat;
    runId?: string;
    runName?: string;
    signal?: AbortSignal;
    stop?: string[];
    tags?: string[];
    timeout?: number;
    tool_choice?: ToolChoice;
    tools?: BindToolsInput[];
    user?: string;
}

Hierarchy

  • BaseChatModelCallOptions
  • Pick<Cerebras.RequestOptions, "httpAgent" | "headers">
    • ChatCerebrasCallOptions

Properties

callbacks? configurable? headers? httpAgent? ls_structured_output_format? maxConcurrency? metadata? recursionLimit? response_format? runId? runName? signal? stop? tags? timeout? tool_choice? tools? user?

Properties

Optionalcallbacks

callbacks?: Callbacks

Callbacks for this call and any sub-calls (eg. a Chain calling an LLM). Tags are passed to all callbacks, metadata is passed to handle*Start callbacks.

Optionalconfigurable

configurable?: Record<string, any>

Runtime values for attributes previously made configurable on this Runnable, or sub-Runnables.

Optionalheaders

headers?: Headers

OptionalhttpAgent

httpAgent?: any

Optionalls_structured_output_format

ls_structured_output_format?: {
    kwargs: {
        method: string;
    };
    schema?: JsonSchema7Type;
}

Describes the format of structured outputs. This should be provided if an output is considered to be structured

Type declaration

  • kwargs: {
        method: string;
    }

    An object containing the method used for structured output (e.g., "jsonMode").

    • method: string
  • Optionalschema?: JsonSchema7Type

    The JSON schema describing the expected output structure.

OptionalmaxConcurrency

maxConcurrency?: number

Maximum number of parallel calls to make.

Optionalmetadata

metadata?: Record<string, unknown>

Metadata for this call and any sub-calls (eg. a Chain calling an LLM). Keys should be strings, values should be JSON-serializable.

OptionalrecursionLimit

recursionLimit?: number

Maximum number of times a call can recurse. If not provided, defaults to 25.

Optionalresponse_format

response_format?: null | ResponseFormat

OptionalrunId

runId?: string

Unique identifier for the tracer run for this call. If not provided, a new UUID will be generated.

OptionalrunName

runName?: string

Name for the tracer run for this call. Defaults to the name of the class.

Optionalsignal

signal?: AbortSignal

Abort signal for this call. If provided, the call will be aborted when the signal is aborted.

See

https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal

Optionalstop

stop?: string[]

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

Optionaltags

tags?: string[]

Tags for this call and any sub-calls (eg. a Chain calling an LLM). You can use these to filter calls.

Optionaltimeout

timeout?: number

Timeout for this call in milliseconds.

Optionaltool_choice

tool_choice?: ToolChoice

Specifies how the chat model should use tools.

Default

undefined

Possible values:
- "auto": The model may choose to use any of the provided tools, or none.
- "any": The model must use one of the provided tools.
- "none": The model must not use any tools.
- A string (not "auto", "any", or "none"): The name of a specific tool the model must use.
- An object: A custom schema specifying tool choice parameters. Specific to the provider.

Note: Not all providers support tool_choice. An error will be thrown
if used with an unsupported model.

Optionaltools

tools?: BindToolsInput[]

Optionaluser

user?: string

Settings

Member Visibility

On This Page

Properties