Interface OpenAiEditRequestDTO

Data Transfer Object for requesting an edit from the OpenAI API.

See

https://beta.openai.com/docs/api-reference/edits

Hierarchy

  • OpenAiEditRequestDTO

Properties

input? instruction model n? temperature? top_p?

Properties

Optional Readonly input

input?: string

The input text to use as the starting point for the edit.

Defaults to ""

See

https://beta.openai.com/docs/api-reference/edits/create#edits/create-input

Readonly instruction

instruction: string

See

https://beta.openai.com/docs/api-reference/edits/create#edits/create-instruction

Readonly model

model: string

The model to use for edit.

See

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

Optional Readonly n

n?: number

How many edits to generate for each prompt.

Defaults to 1

See

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

Optional Readonly temperature

temperature?: number

The temperature to use for sampling.

Defaults to 1

See

https://beta.openai.com/docs/api-reference/edits/create#edits/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/edits/create#edits/create-top_p

Settings

Member Visibility

Theme

Generated using TypeDoc