View Source Anthropic (anthropic_community v0.1.0)

Provides an unofficial Elixir wrapper for the Anthropic API, facilitating access to the Claude LLM model. This module handles configuration, request preparation, and communication with the API.

Summary

Functions

add_assistant_message(request, message)

Adds a assistant message to the request.

add_message(request, role, message)

Adds a message to the request with a specified role.

add_system_message(request, message)

Adds a system message to the request.

add_user_message(request, message)

Adds a user message to the request.

new(opts \\ [])

Initializes a new Anthropic.Config struct with the given options, merging them with the default configuration.

request_next_message(request, http_client_opts \\ [])

Sends the current request to the Anthropic API and awaits the next message in the conversation.

Functions

Link to this function

add_assistant_message(request, message)

View Source

Adds a assistant message to the request.

Parameters

  • request: The Anthropic.Messages.Request struct to which the assistant message will be added.
  • message: The content of the assistant message, must be a binary string.

Returns

Link to this function

add_message(request, role, message)

View Source

Adds a message to the request with a specified role.

Parameters

  • request: The Anthropic.Messages.Request struct to which the message will be added.
  • role: The role of the message (e.g., :user or :assistant).
  • message: The content of the message, can be a binary string, or a list of binary strings that will be treated as different messages.

Returns

Link to this function

add_system_message(request, message)

View Source

Adds a system message to the request.

Parameters

  • request: The current Anthropic.Messages.Request struct to which the system message will be added.
  • message: The system message to add, must be a binary string.

Returns

Errors

Link to this function

add_user_message(request, message)

View Source

Adds a user message to the request.

Parameters

  • request: The Anthropic.Messages.Request struct to which the user message will be added.
  • message: The content of the user message, must be a binary string.

Returns

Link to this function

new(opts \\ [])

View Source

Initializes a new Anthropic.Config struct with the given options, merging them with the default configuration.

Parameters

  • opts: (Optional) A keyword list of options to override the default configuration settings.

Returns

Link to this function

request_next_message(request, http_client_opts \\ [])

View Source

Sends the current request to the Anthropic API and awaits the next message in the conversation.

This function encapsulates the process of sending the prepared request to the Anthropic API, parsing the response, and preparing the next step of the conversation based on the API's response.

Parameters

  • request: The Anthropic.Messages.Request struct that contains the current state of the conversation.
  • http_client_opts: (Optional) A list of options for the HTTP client used to make the request. These options are passed directly to the HTTP client.

Returns

  • On success, returns a tuple {:ok, response_content, updated_request} where response_content is the content of the response from the API, and updated_request is the updated request struct including the response message.
  • On failure, returns a tuple {:error, response, request} where response contains error information provided by the API or HTTP client.

This function is the main mechanism through which conversations are advanced, by sending user or assistant messages to the API and incorporating the API's responses into the ongoing conversation.