Interface OpenAiCompletionRequestDTO

Data Transfer Object for requesting a completion from the OpenAI API.

See

https://beta.openai.com/docs/api-reference/completions/create

Hierarchy

  • OpenAiCompletionRequestDTO

Properties

best_of? echo? frequency_penalty? logit_bias? logprobs? max_tokens? model n? presence_penalty? prompt? stop? stream? suffix? temperature? top_p? user?

Properties

Optional Readonly best_of

best_of?: number

Defaults to 1

See

https://beta.openai.com/docs/api-reference/completions/create#completions/create-best_of

Optional Readonly echo

echo?: boolean

Defaults to false

See

https://beta.openai.com/docs/api-reference/completions/create#completions/create-echo

Optional Readonly frequency_penalty

frequency_penalty?: number

The frequency penalty to use for sampling.

Defaults to 0

See

https://beta.openai.com/docs/api-reference/completions/create#completions/create-frequency_penalty

Optional Readonly logit_bias

logit_bias?: ReadonlyJsonObject

Detaults to null

See

https://beta.openai.com/docs/api-reference/completions/create#completions/create-logit_bias

Optional Readonly logprobs

logprobs?: number

Defaults to null

See

https://beta.openai.com/docs/api-reference/completions/create

Optional Readonly max_tokens

max_tokens?: number

The maximum number of tokens to generate in the completion.

Defaults to 16

See

https://beta.openai.com/docs/api-reference/completions/create#completions/create-max_tokens

Readonly model

model: string

The model to use for completion.

See

https://beta.openai.com/docs/api-reference/completions/create#completions/create-model

Optional Readonly n

n?: number

How many completions to generate for each prompt.

Defaults to 1

See

https://beta.openai.com/docs/api-reference/completions/create#completions/create-n

Optional Readonly presence_penalty

presence_penalty?: number

The presence penalty to use for sampling.

Defaults to 0

See

https://beta.openai.com/docs/api-reference/completions/create#completions/create-presence_penalty

Optional Readonly prompt

prompt?: string | string[]

The prompt to complete.

Defaults to "<|endoftext|>"

See

https://beta.openai.com/docs/api-reference/completions/create#completions/create-prompt

Optional Readonly stop

stop?: boolean

Defaults to false

See

https://beta.openai.com/docs/api-reference/completions/create#completions/create-stop

Optional Readonly stream

stream?: boolean

Defaults to false

See

https://beta.openai.com/docs/api-reference/completions/create#completions/create-stream

Optional Readonly suffix

suffix?: string

See

https://beta.openai.com/docs/api-reference/completions/create#completions/create-suffix

Optional Readonly temperature

temperature?: number

The temperature to use for sampling.

Defaults to 1

See

https://beta.openai.com/docs/api-reference/completions/create#completions/create-temperature

Optional Readonly top_p

top_p?: number

The top probability to use for sampling.

Defaults to 1

See

https://beta.openai.com/docs/api-reference/completions/create#completions/create-top_p

Optional Readonly user

user?: string

See

https://beta.openai.com/docs/api-reference/completions/create#completions/create-user

Settings

Member Visibility

Theme

Generated using TypeDoc