View Source Lightning.AiAssistant (Lightning v2.10.15)

@spec create_session(
  Lightning.Workflows.Job.t(),
  Lightning.Accounts.User.t(),
  String.t()
) ::
  {:ok, Lightning.AiAssistant.ChatSession.t()} | {:error, Ecto.Changeset.t()}

enabled?()

@spec enabled?() :: boolean()

Checks if the AI assistant is enabled.

endpoint_available?()

@spec endpoint_available?() :: boolean()

Checks if the Apollo endpoint is available.

get_session!(id)

@spec get_session!(Ecto.UUID.t()) :: Lightning.AiAssistant.ChatSession.t()

list_sessions_for_job(job, sort_direction \\ :desc)

@spec list_sessions_for_job(Lightning.Workflows.Job.t(), :asc | :desc) ::
  [Lightning.AiAssistant.ChatSession.t(), ...] | []

mark_disclaimer_read(user)

@spec mark_disclaimer_read(Lightning.Accounts.User.t()) ::
  {:ok, Lightning.Accounts.User.t()}

put_expression_and_adaptor(session, expression, adaptor)

@spec put_expression_and_adaptor(
  Lightning.AiAssistant.ChatSession.t(),
  String.t(),
  String.t()
) ::
  Lightning.AiAssistant.ChatSession.t()

query(session, content)

@spec query(Lightning.AiAssistant.ChatSession.t(), String.t()) ::
  {:ok, Lightning.AiAssistant.ChatSession.t()}
  | {:error, String.t() | Ecto.Changeset.t()}

Queries the AI assistant with the given content.

Returns {:ok, session} if the query was successful, otherwise {:error, reason}.

Example

iex> AiAssistant.query(session, "fn()")
{:ok, session}

save_message(session, message, usage \\ %{})

title_max_length()

update_message_status(session, message, status)

@spec update_message_status(
  Lightning.AiAssistant.ChatSession.t(),
  Lightning.AiAssistant.ChatMessage.t(),
  atom()
) :: {:ok, Lightning.AiAssistant.ChatSession.t()} | {:error, Ecto.Changeset.t()}

Updates the status of a specific message within a chat session.

Returns {:ok, session} if the update is successful, otherwise {:error, changeset}.

user_has_read_disclaimer?(user)

@spec user_has_read_disclaimer?(Lightning.Accounts.User.t()) :: boolean()