View Source OpenaiEx.Completion (openai_ex v0.1.5)

This module provides an implementation of the OpenAI completions API. The API reference can be found at https://platform.openai.com/docs/api-reference/completions.

api-fields

API Fields

The following fields can be used as parameters when creating a new completion:

  • :model
  • :prompt
  • :suffix
  • :max_tokens
  • :temperature
  • :top_p
  • :n
  • :stream
  • :logprobs
  • :echo
  • :stop
  • :presence_penalty
  • :frequency_penalty
  • :best_of
  • :logit_bias
  • :user

Link to this section Summary

Functions

Calls the completion 'create' endpoint.

Creates a new completion request with the given arguments.

Link to this section Functions

Link to this function

create(openai, completion)

View Source

Calls the completion 'create' endpoint.

arguments

Arguments

  • openai: The OpenAI configuration.
  • completion: The completion request, as a map with keys corresponding to the API fields.

returns

Returns

A map containing the API response.

See https://platform.openai.com/docs/api-reference/completions/create for more information.

Creates a new completion request with the given arguments.

arguments

Arguments

  • args: A list of key-value pairs, or a map, representing the fields of the completion request.

returns

Returns

A map containing the fields of the completion request.

The :model field is required.

Example usage:

iex> _request = OpenaiEx.Completion.new(model: "davinci")
%{model: "davinci"}

iex> _request = OpenaiEx.Completion.new(%{model: "davinci"})
%{model: "davinci"}