Interface ChatMoonshotParams

Interface defining the input to the MoonshotChatInput class.

interface ChatMoonshotParams {
    model: ModelName;
    modelName: ModelName;
    apiKey?: string;
    frequencyPenalty?: number;
    maxTokens?: number;
    messages?: MoonshotMessage[];
    n?: number;
    presencePenalty?: number;
    stop?: string[];
    streaming?: boolean;
    temperature?: number;
    topP?: number;
}

Implemented by

Properties

model modelName apiKey? frequencyPenalty? maxTokens? messages? n? presencePenalty? stop? streaming? temperature? topP?

Properties

model

model: ModelName

Default

"moonshot-v1-8k"

modelName

modelName: ModelName

Default

"moonshot-v1-8k" Alias for model

Optional apiKey

apiKey?: string

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

Optional frequencyPenalty

frequencyPenalty?: number

Frequency penalty, a number between -2.0 and 2.0. Positive values penalize the newly generated words based on their existing frequency in the text, making the model less likely to repeat the same words verbatim. The default value is 0

Optional maxTokens

maxTokens?: number

Different models have different maximum values. For example, the maximum value of moonshot-v1-8k is 8192. Defaults to 1024

Optional messages

messages?: MoonshotMessage[]

Messages to pass as a prefix to the prompt

Optional n

n?: number

The default value is 1 and cannot be greater than 5. In particular, when temperature is very small and close to 0, we can only return 1 result. If n is already set and > 1, Moonshot will return an invalid input parameter (invalid_request_error).

Optional presencePenalty

presencePenalty?: number

There is a penalty, a number between -2.0 and 2.0. Positive values penalize the newly generated words based on whether they appear in the text, increasing the likelihood that the model will discuss new topics. The default value is 0

Optional stop

stop?: string[]

Optional streaming

streaming?: boolean

Whether to stream the results or not. Defaults to false.

Optional temperature

temperature?: number

Amount of randomness injected into the response. Ranges from 0 to 1 (0 is not included). Use temp closer to 0 for analytical / multiple choice, and temp closer to 1 for creative and generative tasks. Defaults to 0, recommended 0.3

Optional topP

topP?: number

Total probability mass of tokens to consider at each step. Range from 0 to 1. Defaults to 1

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc