interface ChatTogetherAIInput {
    apiKey?: string;
    audio?: ChatCompletionAudioParam;
    cache?: boolean | BaseCache<Generation[]>;
    callbackManager?: CallbackManager;
    callbacks?: Callbacks;
    logprobs?: boolean;
    maxConcurrency?: number;
    maxRetries?: number;
    maxTokens?: number;
    metadata?: Record<string, unknown>;
    modalities?: ChatCompletionModality[];
    model: string;
    modelKwargs?: Record<string, any>;
    modelName: string;
    n: number;
    onFailedAttempt?: FailedAttemptHandler;
    prefixMessages?: ChatCompletionMessageParam[];
    stop?: string[];
    stopSequences?: string[];
    streamUsage?: boolean;
    streaming: boolean;
    supportsStrictToolCalling?: boolean;
    tags?: string[];
    temperature: number;
    timeout?: number;
    togetherAIApiKey?: string;
    topLogprobs?: number;
    topP: number;
    user?: string;
    verbose?: boolean;
}

Hierarchy

  • Omit<OpenAIChatInput, "openAIApiKey" | TogetherAIUnsupportedArgs>
  • BaseChatModelParams
    • ChatTogetherAIInput

Properties

apiKey?: string

The TogetherAI API key to use for requests.

process.env.TOGETHER_AI_API_KEY

Parameters for audio output. Required when audio output is requested with modalities: ["audio"]. Learn more.

cache?: boolean | BaseCache<Generation[]>
callbackManager?: CallbackManager

Use callbacks instead

callbacks?: Callbacks
logprobs?: boolean

Whether to return log probabilities of the output tokens or not. If true, returns the log probabilities of each output token returned in the content of message.

maxConcurrency?: number

The maximum number of concurrent calls that can be made. Defaults to Infinity, which means no limit.

maxRetries?: number

The maximum number of retries that can be made for a single call, with an exponential backoff between each attempt. Defaults to 6.

maxTokens?: number

Maximum number of tokens to generate in the completion. -1 returns as many tokens as possible given the prompt and the model's maximum context size.

metadata?: Record<string, unknown>
modalities?: ChatCompletionModality[]

Output types that you would like the model to generate for this request. Most models are capable of generating text, which is the default:

["text"]

The gpt-4o-audio-preview model can also be used to generate audio. To request that this model generate both text and audio responses, you can use:

["text", "audio"]

model: string

Model name to use

modelKwargs?: Record<string, any>

Holds any additional parameters that are valid to pass to openai.createCompletion that are not explicitly specified on this class.

modelName: string

Model name to use Alias for model

n: number

Number of completions to generate for each prompt

onFailedAttempt?: FailedAttemptHandler

Custom handler to handle failed attempts. Takes the originally thrown error object as input, and should itself throw an error if the input error is not retryable.

prefixMessages?: ChatCompletionMessageParam[]

ChatGPT messages to pass as a prefix to the prompt

stop?: string[]

List of stop words to use when generating Alias for stopSequences

stopSequences?: string[]

List of stop words to use when generating

streamUsage?: boolean

Whether or not to include token usage data in streamed chunks.

true
streaming: boolean

Whether to stream the results or not. Enabling disables tokenUsage reporting

supportsStrictToolCalling?: boolean

Whether the model supports the strict argument when passing in tools. If undefined the strict argument will not be passed to OpenAI.

tags?: string[]
temperature: number

Sampling temperature to use

timeout?: number

Timeout to use when making requests to OpenAI.

togetherAIApiKey?: string

The TogetherAI API key to use for requests. Alias for apiKey

process.env.TOGETHER_AI_API_KEY
topLogprobs?: number

An integer between 0 and 5 specifying the number of most likely tokens to return at each token position, each with an associated log probability. logprobs must be set to true if this parameter is used.

topP: number

Total probability mass of tokens to consider at each step

user?: string

Unique string identifier representing your end-user, which can help OpenAI to monitor and detect abuse.

verbose?: boolean