Interface OpenAIInput

Input to OpenAI class.

interface OpenAIInput {
    batchSize: number;
    frequencyPenalty: number;
    model: string;
    modelName: string;
    n: number;
    presencePenalty: number;
    streaming: boolean;
    temperature: number;
    topP: number;
    apiKey?: string;
    bestOf?: number;
    logitBias?: Record<string, number>;
    maxTokens?: number;
    modelKwargs?: Record<string, any>;
    openAIApiKey?: string;
    stop?: string[];
    stopSequences?: string[];
    streamUsage?: boolean;
    timeout?: number;
    user?: string;
}

Hierarchy (view full)

Implemented by

Properties

batchSize frequencyPenalty model modelName n presencePenalty streaming temperature topP apiKey? bestOf? logitBias? maxTokens? modelKwargs? openAIApiKey? stop? stopSequences? streamUsage? timeout? user?

Properties

batchSize

batchSize: number

Batch size to use when passing multiple documents to generate

frequencyPenalty

frequencyPenalty: number

Penalizes repeated tokens according to frequency

model

model: string

Model name to use

modelName

modelName: string

Model name to use Alias for model

n

n: number

Number of completions to generate for each prompt

presencePenalty

presencePenalty: number

Penalizes repeated tokens

streaming

streaming: boolean

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

temperature

temperature: number

Sampling temperature to use

topP

topP: number

Total probability mass of tokens to consider at each step

Optional apiKey

apiKey?: string

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

Optional bestOf

bestOf?: number

Generates bestOf completions server side and returns the "best"

Optional logitBias

logitBias?: Record<string, number>

Dictionary used to adjust the probability of specific tokens being generated

Optional maxTokens

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.

Optional modelKwargs

modelKwargs?: Record<string, any>

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

Optional openAIApiKey

openAIApiKey?: string

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

Optional stop

stop?: string[]

List of stop words to use when generating Alias for stopSequences

Optional stopSequences

stopSequences?: string[]

List of stop words to use when generating

Optional streamUsage

streamUsage?: boolean

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

Default

true

Optional timeout

timeout?: number

Timeout to use when making requests to OpenAI.

Optional user

user?: string

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

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc