openai_client
v0.5.3

OpenAI.Edits (openai_client v0.5.3)

Given a prompt and an instruction, the model will return an edited version of the prompt.

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

Link to this section Summary

Types

create_params()

Functions

create(client, params, opts \\ [])

Creates a new edit for the provided input, instruction, and parameters.

Link to this section Types

Link to this type

create_params()

@type create_params() :: %{
  :model => String.t(),
  optional(:input) => String.t(),
  :instruction => String.t(),
  optional(:n) => integer(),
  optional(:temperature) => float(),
  optional(:top_p) => float()
}

Link to this section Functions

Link to this function

create(client, params, opts \\ [])

@spec create(OpenAI.Client.t(), create_params(), Keyword.t()) ::
  OpenAI.Client.result()

Creates a new edit for the provided input, instruction, and parameters.