Interface HFInput

Interface defining the parameters for configuring the Hugging Face model for text generation.

interface HFInput {
    apiKey?: string;
    endpointUrl?: string;
    frequencyPenalty?: number;
    includeCredentials?: string | boolean;
    maxTokens?: number;
    model: string;
    stopSequences?: string[];
    temperature?: number;
    topK?: number;
    topP?: number;
}

Implemented by

Properties

apiKey? endpointUrl? frequencyPenalty? includeCredentials? maxTokens? model stopSequences? temperature? topK? topP?

Properties

OptionalapiKey

apiKey?: string

API key to use.

OptionalendpointUrl

endpointUrl?: string

Custom inference endpoint URL to use

OptionalfrequencyPenalty

frequencyPenalty?: number

Penalizes repeated tokens according to frequency

OptionalincludeCredentials

includeCredentials?: string | boolean

Credentials to use for the request. If this is a string, it will be passed straight on. If it's a boolean, true will be "include" and false will not send credentials at all.

OptionalmaxTokens

maxTokens?: number

Maximum number of tokens to generate in the completion.

model

model: string

Model to use

OptionalstopSequences

stopSequences?: string[]

The model will stop generating text when one of the strings in the list is generated.

Optionaltemperature

temperature?: number

Sampling temperature to use

OptionaltopK

topK?: number

Integer to define the top tokens considered within the sample operation to create new text.

OptionaltopP

topP?: number

Total probability mass of tokens to consider at each step

Settings

Member Visibility

On This Page

Properties