View Source OpenaiEx.Completion (openai_ex v0.5.4)

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

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

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

Summary

Functions

Calls the completion 'create' endpoint.

Creates a new completion request with the given arguments.

Functions

Link to this function

create(openai, completion)

View Source
Link to this function

create(openai, completion, list)

View Source

Calls the completion 'create' endpoint.

Arguments

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

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

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

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"}