Current section

Files

Jump to
oapi_open_ai lib schemas completion create_request.ex
Raw

lib/schemas/completion/create_request.ex

defmodule OpenAi.Completion.CreateRequest do
@moduledoc """
Provides struct and type for a Completion.CreateRequest
"""
@type t :: %__MODULE__{
best_of: integer | nil,
echo: boolean | nil,
frequency_penalty: number | nil,
logit_bias: OpenAi.Completion.CreateRequest.LogitBias.t() | nil,
logprobs: integer | nil,
max_tokens: integer | nil,
model: String.t(),
n: integer | nil,
presence_penalty: number | nil,
prompt: String.t() | [integer] | [String.t()] | [[integer]] | nil,
seed: integer | nil,
stop: String.t() | [String.t()] | nil,
stream: boolean | nil,
stream_options: OpenAi.Chat.Completion.StreamOptions.t() | nil,
suffix: String.t() | nil,
temperature: number | nil,
top_p: number | nil,
user: String.t() | nil
}
defstruct [
:best_of,
:echo,
:frequency_penalty,
:logit_bias,
:logprobs,
:max_tokens,
:model,
:n,
:presence_penalty,
:prompt,
:seed,
:stop,
:stream,
:stream_options,
:suffix,
:temperature,
:top_p,
:user
]
@doc false
@spec __fields__(atom) :: keyword
def __fields__(type \\ :t)
def __fields__(:t) do
[
best_of: :integer,
echo: :boolean,
frequency_penalty: :number,
logit_bias: {OpenAi.Completion.CreateRequest.LogitBias, :t},
logprobs: :integer,
max_tokens: :integer,
model:
{:union, enum: ["gpt-3.5-turbo-instruct", "davinci-002", "babbage-002"], string: :generic},
n: :integer,
presence_penalty: :number,
prompt: {:union, [{:string, :generic}, [:integer], [string: :generic], [[:integer]]]},
seed: :integer,
stop: {:union, [{:string, :generic}, [string: :generic]]},
stream: :boolean,
stream_options: {OpenAi.Chat.Completion.StreamOptions, :t},
suffix: {:string, :generic},
temperature: :number,
top_p: :number,
user: {:string, :generic}
]
end
end