View Source Anthropic (anthropic_community v0.4.2)
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, offering an idiomatic Elixir interface to the Anthropic AI capabilities.
Key Features
- Tool Invocations: Allows registering and executing custom tool modules that implement the
Anthropic.Tools.ToolBehaviour
, enabling dynamic handling of function invocations from the assistant's responses. - Configuration Management: Centralizes settings for the Anthropic API, such as model specifications, API keys, and request parameters, ensuring a consistent request configuration.
- Message Handling: Supports adding various types of messages to the request, including text and image content, enhancing interaction with the Anthropic AI.
- Error Handling: Implements comprehensive error handling for both request generation and response parsing, providing clear feedback on failures.
- Telemetry Integration: Integrates with Elixir's
:telemetry
library to emit events for key operations, enabling monitoring and observability.
Configuration
Please refer to Antrhopic.Config
for more details.
Usage
Start by configuring the API settings, then use the provided functions to add messages or images to your request. Finally, send the request to the Anthropic API and handle the response:
{:ok, response, updated_request} =
Anthropic.new(max_tokens: 500, api_key: "API_KEY")
|> Anthropic.add_user_message(config, "Hello, Anthropic!")
|> Anthropic.request_next_message()
Error Handling
The module returns errors in the format {:error, reason}
, where reason
can be:
- A map containing error details from the Anthropic API, with an "error" key indicating the type of error.
- A
Finch.Error
struct if there was an issue with the HTTP request. - A
Jason.DecodeError
struct if there was an issue decoding the JSON response. - An
:unknown_error
atom if an unexpected error occurred.
Telemetry
This module emits several :telemetry
events to help monitor its operations, which can be observed for logging, metrics, or operational insights.
Events
[:anthropic, :request_next_message, :start]
- Emitted at the beginning of a request to the Anthropic API.- Measurements:
%{system_time: integer()}
- Metadata:
%{model: String.t(), max_tokens: integer()}
- Measurements:
[:anthropic, :request_next_message, :stop]
- Emitted after a request to the Anthropic API successfully completes.- Measurements:
%{duration: integer()}
- Metadata:
%{model: String.t(), max_tokens: integer(), input_tokens: integer(), output_tokens: integer()}
- Measurements:
[:anthropic, :request_next_message, :exception]
- Emitted if an exception occurs during a request to the Anthropic API.- Measurements:
%{duration: integer()}
- Metadata:
%{model: String.t(), max_tokens: integer(), kind: Exception.kind(), reason: term(), stacktrace: Exception.stacktrace()}
- Measurements:
Metrics
Each telemetry event includes metadata with the following information:
:model
- The name of the model used for the request.:max_tokens
- The maximum number of tokens allowed in the generated response.:input_tokens
- The number of tokens in the input message (only available in the:stop
event).:output_tokens
- The number of tokens in the generated response (only available in the:stop
event).:kind
- The type of exception that occurred (only available in the:exception
event).:reason
- The reason for the exception (only available in the:exception
event).:stacktrace
- The stacktrace of the exception (only available in the:exception
event).
By attaching to these events, you can monitor the performance and health of your Anthropic API integration, track usage metrics, and handle exceptions as needed.
Summary
Functions
Adds a assistant message to the request.
Adds a message to the request with a specified role.
Adds a system message to the request.
Adds an image message to the request.
A shorthand to add a user message to a request.
Initializes a new Anthropic.Messages.Request
struct with the given options, merging them with the default configuration Anthropic.Config
.
Processes the tool invocations present in the assistant's response.
Registers a tool module with the given request.
Sends the current request to the Anthropic API and awaits the next message in the conversation.
Types
@type role() :: :user | :assistant
Functions
Adds a assistant message to the request.
Parameters
request
: TheAnthropic.Messages.Request
struct to which the assistant message will be added.message
: The content of the assistant message.
Returns
- The updated
Anthropic.Messages.Request
struct with the assistant message added.
Adds a message to the request with a specified role.
Parameters
request
: TheAnthropic.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, which can be one of the following:- A binary string representing a single text message, that will be converted to a content of type
text
. - A list of binary strings representing multiple text messages.
- A content object representing a single message with a specific type (e.g., text or image).
- A list of content objects representing multiple messages with specific types.
- A binary string representing a single text message, that will be converted to a content of type
Returns
- The updated
Anthropic.Messages.Request
struct with the new message(s) added.
Examples
# Adding a single text message
request = Anthropic.add_message(request, :user, "Hello!")
# Adding multiple text messages
request = Anthropic.add_message(request, :user, ["Hello!", "How are you?"])
# Adding a single content object
content_object = %{type: "text", text: "Hello!"}
request = Anthropic.add_message(request, :user, content_object)
# Adding multiple content objects
content_objects = [
%{type: "text", text: "Hello!"},
%{type: "image", source: %{data: "base64_encoded_data", type: "base64", media_type: "image/png"}}
]
request = Anthropic.add_message(request, :user, content_objects)
@spec add_system_message(Anthropic.Messages.Request.t(), binary()) :: Anthropic.Messages.Request.t()
Adds a system message to the request.
Parameters
request
: AAnthropic.Messages.Request
struct to which the system message will be added.message
: The system message to add, must be a binary string.
Returns
- The updated
Anthropic.Messages.Request
struct with the system message added.
Errors
- Raises
ArgumentError
if the message is not a binary string.
@spec add_user_image( Anthropic.Messages.Request.t(), {Anthropic.Messages.Content.Image.input_type(), binary()} ) :: Anthropic.Messages.Request.t()
Adds an image message to the request.
Processes the given image, converts it to a base64 encoded string, and adds it as a message to the request with a role of :user
.
Parameters
request
: TheAnthropic.Messages.Request
struct to which the image message will be added.image_data
: A tuple consisting of the input type and the image path or binary data. The input type should be one of:path
,:binary
, or:base64
, indicating how the image is provided.
Returns
- The updated
Anthropic.Messages.Request
struct with the image message added.
Examples
Anthropic.add_user_image(request, {:path, "/path/to/image.png"})
# Adds an image from a local file path
Anthropic.add_user_image(request, {:binary, <<binary data>>})
# Adds an image from binary data
Anthropic.add_user_image(request, {:base64, "base64 encoded image data"})
# Adds an image from a base64 encoded string
Errors
- Returns
{:error, reason}
if the image processing fails, wherereason
is a descriptive error message.
@spec add_user_message( Anthropic.Messages.Request.t(), Anthropic.Messages.Request.message() | [Anthropic.Messages.Request.message()] | binary() | [binary()] ) :: Anthropic.Messages.Request.t()
A shorthand to add a user message to a request.
Parameters
request
: TheAnthropic.Messages.Request
struct to which the user message will be added.message
: The content of the user message.
Returns
- The updated
Anthropic.Messages.Request
struct with the user message added.
Initializes a new Anthropic.Messages.Request
struct with the given options, merging them with the default configuration Anthropic.Config
.
Parameters
opts
: (Optional) A keyword list of options to override the default configuration settings. Refer toAnthropic.Messages.Request
for options that can be overridden.
Returns
- A new
Anthropic.Messages.Request
struct populated with the merged configuration options.
@spec process_invocations( {:ok, Anthropic.Messages.Response.t(), Anthropic.Messages.Request.t()} | {:error, any(), Anthropic.Messages.Request.t()} ) :: {:ok, Anthropic.Messages.Response.t(), Anthropic.Messages.Request.t()} | {:error, any(), Anthropic.Messages.Request.t()}
Processes the tool invocations present in the assistant's response.
This function takes the result of request_next_message/1
and checks if there are any tool invocations in the response.
If invocations are found, it executes each one using the registered tools and appends the results to the conversation.
It then sends the updated conversation back to the API for further processing.
Parameters
result
: The result ofrequest_next_message/1
, which can be either{:ok, response, request}
or{:error, response, request}
.request
: AAnthropic.Messages.Request
.
Returns
{:ok, response, updated_request}
: If the invocations are processed successfully, whereresponse
is the original response from the API, andupdated_request
is the request struct updated with the invocation results.{:error, response, request}
: If an error occurs during the processing of invocations, whereresponse
contains the error details, andrequest
is the original request struct.
Raises
ArgumentError
: If a tool invocation fails due to the specified tool not being registered or if there's an error during the execution of the tool.
This function is responsible for handling the dynamic execution of tools based on the assistant's responses. It allows for a more interactive and extensible conversation flow by processing tool invocations and incorporating their results into the ongoing conversation.
@spec register_tool(Anthropic.Messages.Request.t(), atom()) :: Anthropic.Messages.Request.t()
Registers a tool module with the given request.
This function allows developers to register tools that implement the Anthropic.Tools.ToolBehaviour
.
Registered tools will be added to the system message automaticaly at the time of the request, and will be made
available to the assistant. Once the assistant invokes a function call, it will be processed and the result will be returned
back to the assistant.
The Anthropic.Tools.ToolBehaviour
requires the following callbacks to be implemented:
description/0
: Returns a string describing the purpose and functionality of the tool.parameters/0
: Returns a list of parameter specifications, each represented as a tuple{name, type, description}
.name
: An atom representing the name of the parameter.type
: The type of the parameter, which can be:string
,:float
, or:integer
.description
: A string describing the parameter.
invoke/1
: Accepts a Keyword list of arguments and returns the result of the tool invocation as a string.
By implementing these callbacks, developers can create custom tools that can be dynamically invoked by the assistant during the conversation.
Parameters
request
: TheAnthropic.Messages.Request
struct that represents the current state of the conversation.tool_module
: The module that implements theAnthropic.Tools.ToolBehaviour
, to be registered with the request.
Returns
- An updated
Anthropic.Messages.Request
struct with the tool module registered.
Examples
defmodule MyCustomTool do
@behaviour Anthropic.Tools.ToolBehaviour
def description, do: "A custom tool for demonstration purposes"
def parameters, do: [
{:name, :string, "The name of the person"},
{:age, :integer, "The age of the person"}
]
def invoke([name, age]) do
"Hello, #{name}! You are #{age} years old."
end
end
request = Anthropic.register_tool(request, MyCustomTool)
@spec request_next_message(Anthropic.Messages.Request.t(), keyword() | nil) :: any()
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
: TheAnthropic.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}
whereresponse_content
is the content of the response from the API, andupdated_request
is the updated request struct including the response message. - On failure, returns a tuple
{:error, response, request}
whereresponse
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.