EditParameters

EditParameters

Parameter struct for the Edit endpoint.

public struct EditParameters 

Initializers

init(model:input:instruction:numberOfEdits:temperature:topP:)

public init(
        model: String,
        input: String = "\"",
        instruction: String,
        numberOfEdits: Int = 1,
        temperature: Double = 1.0,
        topP: Double = 1.0
    ) 

Properties

model

ID of the model to use.

public var model: String

You can use the List models API to see all of your available models, or see our Model overview for descriptions of them.

input

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

public var input: String

instruction

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

public var instruction: String

numberOfEdits

How many edits to generate for the input and instruction.

public var numberOfEdits: Int

temperature

What sampling temperature to use.

public var temperature: Double

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.

We generally recommend altering this or top_p but not both.

topP

An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass.

public var topP: Double

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.

body

The body of the URL used for OpenAI API requests.

public var body: [String: Any]