@spec completions(
  Meili.Client.t() | String.t(),
  String.t() | map() | nil,
  map() | Keyword.t(),
  Keyword.t()
) :: {:ok, map()} | {:error, Meili.Error.t()}

Performs a chat completion request in a specific workspace.

Additional Req options (like :into for streaming chunks) can be passed in the opts keyword list.

Examples

body = %{
  model: "gpt-4",
  messages: [%{role: "user", content: "Hello!"}],
  stream: true
}
# Streaming with into:
Meili.Chat.completions("default", body, into: fn {:data, chunk}, state ->
  IO.write(chunk)
  {:cont, state}
end)

@spec completions!(
  Meili.Client.t() | String.t(),
  String.t() | map() | nil,
  map() | Keyword.t(),
  Keyword.t()
) :: map() | no_return()

Performs a chat completion request, raising on error.

Examples

body = %{
  model: "gpt-4",
  messages: [%{role: "user", content: "Hello!"}]
}
result = Meili.Chat.completions!("default", body)

@spec get_settings(Meili.Client.t() | String.t(), String.t() | nil) ::
  {:ok, map()} | {:error, Meili.Error.t()}

Gets settings for a specific chat workspace.

Examples

Meili.Chat.get_settings("default")
Meili.Chat.get_settings(client, "default")

@spec get_settings!(Meili.Client.t() | String.t(), String.t() | nil) ::
  map() | no_return()

Gets settings for a specific chat workspace, raising on error.

Examples

Meili.Chat.get_settings!("default")
Meili.Chat.get_settings!(client, "default")

@spec reset_settings(Meili.Client.t() | String.t(), String.t() | nil) ::
  {:ok, term()} | {:error, Meili.Error.t()}

Resets settings for a specific chat workspace to their defaults.

Examples

Meili.Chat.reset_settings("default")
Meili.Chat.reset_settings(client, "default")

@spec reset_settings!(Meili.Client.t() | String.t(), String.t() | nil) ::
  term() | no_return()

Resets settings for a specific chat workspace, raising on error.

Examples

Meili.Chat.reset_settings!("default")
Meili.Chat.reset_settings!(client, "default")

@spec update_settings(
  Meili.Client.t() | String.t(),
  String.t() | map() | Keyword.t() | nil,
  map() | Keyword.t() | nil
) :: {:ok, map()} | {:error, Meili.Error.t()}

Updates settings for a specific chat workspace.

Examples

settings = %{
  searchable_attributes: ["title"],
  system_prompt: "You are a helpful assistant."
}
Meili.Chat.update_settings("default", settings)
Meili.Chat.update_settings(client, "default", settings)

@spec update_settings!(
  Meili.Client.t() | String.t(),
  String.t() | map() | Keyword.t() | nil,
  map() | Keyword.t() | nil
) :: map() | no_return()

Updates settings for a specific chat workspace, raising on error.

Examples

settings = %{searchable_attributes: ["title"]}
Meili.Chat.update_settings!("default", settings)
Meili.Chat.update_settings!(client, "default", settings)