Codex.AppServer.V1 (Codex SDK v0.7.2)

Copy Markdown View Source

Legacy v1 app-server endpoints for compatibility with older servers.

Summary

Types

connection()

@type connection() :: pid()

Functions

add_conversation_listener(conn, conversation_id, opts \\ [])

@spec add_conversation_listener(connection(), String.t(), keyword()) ::
  {:ok, map()} | {:error, term()}

interrupt_conversation(conn, conversation_id)

@spec interrupt_conversation(connection(), String.t()) ::
  {:ok, map()} | {:error, term()}

list_conversations(conn, opts \\ [])

@spec list_conversations(
  connection(),
  keyword()
) :: {:ok, map()} | {:error, term()}

new_conversation(conn, params \\ %{})

@spec new_conversation(connection(), map() | keyword()) ::
  {:ok, map()} | {:error, term()}

remove_conversation_listener(conn, subscription_id)

@spec remove_conversation_listener(connection(), String.t()) ::
  {:ok, map()} | {:error, term()}

resume_conversation(conn, params \\ %{})

@spec resume_conversation(connection(), map() | keyword()) ::
  {:ok, map()} | {:error, term()}

send_user_message(conn, conversation_id, input)

@spec send_user_message(connection(), String.t(), String.t() | [map()]) ::
  {:ok, map()} | {:error, term()}

send_user_turn(conn, conversation_id, input, opts \\ [])

@spec send_user_turn(connection(), String.t(), String.t() | [map()], keyword()) ::
  {:ok, map()} | {:error, term()}