Skip to main content
Module

x/openai/mod.ts>EditOptions

Unofficial Deno wrapper for the Open Ai api
Extremely Popular
Go to Latest
interface EditOptions
import { type EditOptions } from "https://deno.land/x/openai@1.3.2/mod.ts";

Properties

model: string

ID of the model to use. You can use the text-davinci-edit-001 or code-davinci-edit-001 model with this endpoint. https://platform.openai.com/docs/api-reference/edits/create#edits/create-model

optional
input: string

The input text to use as a starting point for the edit. https://platform.openai.com/docs/api-reference/edits/create#edits/create-input

instruction: string

The instruction that tells the model how to edit the prompt. https://platform.openai.com/docs/api-reference/edits/create#edits/create-instruction

optional
n: number

How many edits to generate for the input and instruction. https://platform.openai.com/docs/api-reference/edits/create#edits/create-n

optional
temperature: number

What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. We generally recommend altering this or top_p but not both. https://platform.openai.com/docs/api-reference/edits/create#edits/create-temperature

optional
topP: number

An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered. We generally recommend altering this or temperature but not both. https://platform.openai.com/docs/api-reference/edits/create#edits/create-top_p