openai-core/com.aallam.openai.api.edits/EditsRequest

EditsRequest

@Serializable

class EditsRequest(val model: ModelId, val instruction: String, val input: String? = null, val temperature: Double? = null, val topP: Double? = null)

A request for OpenAI to creates a new edit for the provided input, instruction, and parameters.

Constructors

constructor(model: ModelId, instruction: String, input: String? = null, temperature: Double? = null, topP: Double? = null)

Properties

@SerialName(value = "input")

val input: String? = null

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

@SerialName(value = "instruction")

val instruction: String

The instruction that tells the model how to edit the prompt.

@SerialName(value = "model")

val model: ModelId

ID of the model to use.

@SerialName(value = "temperature")

val temperature: Double? = null

What sampling temperature to use. Higher values means the model will take more risks. Try 0.9 for more creative applications, and 0 (argmax sampling) for ones with a well-defined answer.

@SerialName(value = "top_p")

val topP: Double? = null

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.