ExAgent.Services.OpenAIService (ExAgent v0.4.1)

Copy Markdown View Source

HTTP service for OpenAI chat completions API.

Handles payload formatting and response parsing for the OpenAI /chat/completions endpoint using Req.

Summary

Functions

chat(provider, messages, opts \\ [])

Sends a chat completion request to the OpenAI API.

stream(provider, messages, opts \\ [])

Streams a chat completion from the OpenAI API as a lazy enumerable of text chunks.

Functions

chat(provider, messages, opts \\ [])

@spec chat(
  ExAgent.Providers.OpenAI.t(),
  [ExAgent.Message.t()],
  keyword()
) :: {:ok, Response.t()} | {:tool_calls, [map()]} | {:error, ExAgent.Error.t()}

Sends a chat completion request to the OpenAI API.

stream(provider, messages, opts \\ [])

@spec stream(ExAgent.Providers.OpenAI.t(), [ExAgent.Message.t()], keyword()) ::
  Enumerable.t()

Streams a chat completion from the OpenAI API as a lazy enumerable of text chunks.