AI.CompletionAPI (fnord v0.8.83)

View Source

Summary

Types

model()
msg_response()
msgs()
response()
response_format()
tool_response()
tools()
usage()
web_search?()

Functions

get(model, msgs, tools \\ nil, response_format \\ nil, web_search? \\ false)

Types

model()

@type model() :: AI.Model.t()

msg_response()

@type msg_response() :: {:ok, :msg, binary(), usage()}

msgs()

@type msgs() :: [map()]

response()

@type response() ::
  msg_response()
  | tool_response()
  | {:error, map()}
  | {:error, :api_unavailable, any()}
  | {:error, :context_length_exceeded, non_neg_integer()}

response_format()

@type response_format() :: nil | map()

tool_response()

@type tool_response() :: {:ok, :tool, [map()]}

tools()

@type tools() :: nil | [AI.Tools.tool_spec()]

usage()

@type usage() :: non_neg_integer()

web_search?()

@type web_search?() :: boolean()

Functions

get(model, msgs, tools \\ nil, response_format \\ nil, web_search? \\ false)

@spec get(model(), msgs(), tools(), response_format(), web_search?()) :: response()