Interface ChatDeepSeekInput

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

Hierarchy

  • ChatOpenAIFields
    • ChatDeepSeekInput

Properties

apiKey? audio? cache? callbackManager? callbacks? configuration? disableStreaming? frequencyPenalty? logitBias? logprobs? maxCompletionTokens? maxConcurrency? maxRetries? maxTokens? metadata? modalities? model? modelKwargs? modelName? n? onFailedAttempt? openAIApiKey? prefixMessages? presencePenalty? reasoningEffort? stop? stopSequences? streamUsage? streaming? supportsStrictToolCalling? tags? temperature? timeout? topLogprobs? topP? user? verbose?

Properties

OptionalapiKey

apiKey?: string

The Deepseek API key to use for requests.

Default

process.env.DEEPSEEK_API_KEY

Optionalaudio

audio?: ChatCompletionAudioParam

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

Optionalcache

cache?: boolean | BaseCache<Generation[]>

OptionalcallbackManager

callbackManager?: CallbackManager

Deprecated

Use callbacks instead

Optionalcallbacks

callbacks?: Callbacks

Optionalconfiguration

configuration?: ClientOptions

OptionaldisableStreaming

disableStreaming?: boolean

Whether to disable streaming.

If streaming is bypassed, then stream() will defer to invoke().

  • If true, will always bypass streaming case.
  • If false (default), will always use streaming case if available.

OptionalfrequencyPenalty

frequencyPenalty?: number

Penalizes repeated tokens according to frequency

OptionallogitBias

logitBias?: Record<string, number>

Dictionary used to adjust the probability of specific tokens being generated

Optionallogprobs

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.

OptionalmaxCompletionTokens

maxCompletionTokens?: 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. Alias for maxTokens for reasoning models.

OptionalmaxConcurrency

maxConcurrency?: number

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

OptionalmaxRetries

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.

OptionalmaxTokens

maxTokens?: number

The maximum number of tokens that the model can process in a single response. This limits ensures computational efficiency and resource management.

Optionalmetadata

metadata?: Record<string, unknown>

Optionalmodalities

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"]

Optionalmodel

model?: string

The name of the model to use.

OptionalmodelKwargs

modelKwargs?: Record<string, any>

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

OptionalmodelName

modelName?: string

Model name to use Alias for model

Deprecated

Use "model" instead.

Optionaln

n?: number

Number of completions to generate for each prompt

OptionalonFailedAttempt

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.

OptionalopenAIApiKey

openAIApiKey?: string

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

OptionalprefixMessages

prefixMessages?: ChatCompletionMessageParam[]

ChatGPT messages to pass as a prefix to the prompt

OptionalpresencePenalty

presencePenalty?: number

Penalizes repeated tokens

OptionalreasoningEffort

reasoningEffort?: ChatCompletionReasoningEffort

Constrains effort on reasoning for reasoning models. Currently supported values are low, medium, and high. Reducing reasoning effort can result in faster responses and fewer tokens used on reasoning in a response.

Optionalstop

stop?: string[]

Up to 4 sequences where the API will stop generating further tokens. The returned text will not contain the stop sequence. Alias for stopSequences

OptionalstopSequences

stopSequences?: string[]

Up to 4 sequences where the API will stop generating further tokens. The returned text will not contain the stop sequence.

OptionalstreamUsage

streamUsage?: boolean

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

Default

true

Optionalstreaming

streaming?: boolean

Whether or not to stream responses.

OptionalsupportsStrictToolCalling

supportsStrictToolCalling?: boolean

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

Optionaltags

tags?: string[]

Optionaltemperature

temperature?: number

The temperature to use for sampling.

Optionaltimeout

timeout?: number

Timeout to use when making requests to OpenAI.

OptionaltopLogprobs

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.

OptionaltopP

topP?: number

Total probability mass of tokens to consider at each step

Optionaluser

user?: string

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

Optionalverbose

verbose?: boolean

Settings

Member Visibility

On This Page

Properties