interface ChatTogetherAICallOptions {
    callbacks?: Callbacks;
    configurable?: Record<string, any>;
    maxConcurrency?: number;
    metadata?: Record<string, unknown>;
    options?: OpenAICoreRequestOptions<Record<string, unknown>>;
    parallel_tool_calls?: boolean;
    promptIndex?: number;
    recursionLimit?: number;
    response_format: {
        schema: Record<string, unknown>;
        type: "json_object";
    };
    runId?: string;
    runName?: string;
    seed?: number;
    signal?: AbortSignal;
    stop?: string[];
    stream_options?: {
        include_usage: boolean;
    };
    strict?: boolean;
    tags?: string[];
    timeout?: number;
    tool_choice?: OpenAIToolChoice;
    tools?: ChatOpenAIToolType[];
}

Hierarchy

  • Omit<ChatOpenAICallOptions, TogetherAIUnsupportedCallOptions>
    • ChatTogetherAICallOptions

Properties

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.

configurable?: Record<string, any>

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

maxConcurrency?: number

Maximum number of parallel calls to make.

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.

options?: OpenAICoreRequestOptions<Record<string, unknown>>

Additional options to pass to the underlying axios request.

parallel_tool_calls?: boolean

Whether or not to restrict the ability to call multiple tools in one response.

promptIndex?: number
recursionLimit?: number

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

response_format: {
    schema: Record<string, unknown>;
    type: "json_object";
}
runId?: string

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

runName?: string

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

seed?: number
signal?: AbortSignal

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

stop?: string[]

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

stream_options?: {
    include_usage: boolean;
}

Additional options to pass to streamed completions. If provided takes precedence over "streamUsage" set at initialization time.

Type declaration

  • include_usage: boolean

    Whether or not to include token usage in the stream. If set to true, this will include an additional chunk at the end of the stream with the token usage.

strict?: boolean

If true, model output is guaranteed to exactly match the JSON Schema provided in the tool definition. If true, the input schema will also be validated according to https://platform.openai.com/docs/guides/structured-outputs/supported-schemas.

If false, input schema will not be validated and model output will not be validated.

If undefined, strict argument will not be passed to the model.

0.2.6

tags?: string[]

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

timeout?: number

Timeout for this call in milliseconds.

tool_choice?: OpenAIToolChoice
tools?: ChatOpenAIToolType[]