interface OpenAIChatInput {
    frequencyPenalty: number;
    model: string;
    modelName: string;
    n: number;
    presencePenalty: number;
    streaming: boolean;
    temperature: number;
    topP: number;
    apiKey?: string;
    logitBias?: Record<string, number>;
    logprobs?: boolean;
    maxTokens?: number;
    modelKwargs?: Record<string, any>;
    openAIApiKey?: string;
    prefixMessages?: ChatCompletionMessageParam[];
    stop?: string[];
    stopSequences?: string[];
    streamUsage?: boolean;
    supportsStrictToolCalling?: boolean;
    timeout?: number;
    topLogprobs?: number;
    user?: string;
}

Hierarchy (view full)

Implemented by

Properties

frequencyPenalty: number

Penalizes repeated tokens according to frequency

model: string

Model name to use

modelName: string

Model name to use Alias for model

n: number

Number of completions to generate for each prompt

presencePenalty: number

Penalizes repeated tokens

streaming: boolean

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

temperature: number

Sampling temperature to use

topP: number

Total probability mass of tokens to consider at each step

apiKey?: string

API key to use when making requests to OpenAI. Defaults to the value of OPENAI_API_KEY environment variable.

logitBias?: Record<string, number>

Dictionary used to adjust the probability of specific tokens being generated

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.

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.

modelKwargs?: Record<string, any>

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

openAIApiKey?: string

API key to use when making requests to OpenAI. Defaults to the value of OPENAI_API_KEY environment variable. Alias for apiKey

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
supportsStrictToolCalling?: boolean

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

timeout?: number

Timeout to use when making requests to OpenAI.

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.

user?: string

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