1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499
//! An unofficial Rust client for [the Anthropic/Claude API](https://docs.anthropic.com/claude/reference/getting-started-with-the-api).
//!
//! ## Supported APIs
//! - [Messages](`crate::messages`)
//! - [x] [Create a Message](https://docs.anthropic.com/claude/reference/messages_post)
//! - [x] [Streaming Messages](https://docs.anthropic.com/claude/reference/messages-streaming)
//!
//! ## Feature flags
//! - `macros`: Enable the [`attributes::clust_tool`] attribute macro for generating [`messages::ToolDefinition`]
//! or [`messages::AsyncTool`] from a Rust function.
//!
//! ## Usages
//!
//! ### API key and client
//! First you need to create a new API client: `clust::Client` with your Anthropic API key from environment variable: "ANTHROPIC_API_KEY"
//!
//! ```rust,no_run
//! use clust::Client;
//!
//! let client = Client::from_env().unwrap();
//! ```
//!
//! or specify the API key directly:
//!
//! ```rust
//! use clust::Client;
//! use clust::ApiKey;
//!
//! let client = Client::from_api_key(ApiKey::new("your-api-key"));
//! ```
//!
//! If you want to customize the client, you can use builder pattern by `clust::ClientBuilder`:
//! ```rust
//! use clust::ClientBuilder;
//! use clust::ApiKey;
//! use clust::Version;
//!
//! let client = ClientBuilder::new(ApiKey::new("your-api-key"))
//! .version(Version::V2023_06_01)
//! .client(reqwest::ClientBuilder::new().timeout(std::time::Duration::from_secs(10)).build().unwrap())
//! .build();
//! ```
//!
//! ### Models and max tokens
//! You can specify the model by `clust::messages::ClaudeModel`.
//!
//! ```rust
//! use clust::messages::ClaudeModel;
//! use clust::messages::MessagesRequestBody;
//!
//! let model = ClaudeModel::Claude3Sonnet20240229;
//!
//! let request_body = MessagesRequestBody {
//! model,
//! ..Default::default()
//! };
//! ```
//!
//! Because max number of tokens of text generation: `clust::messages::MaxTokens` depends on the model,
//! you need to create `clust::messages::MaxTokens` with the model.
//!
//! ```rust
//! use clust::messages::ClaudeModel;
//! use clust::messages::MaxTokens;
//! use clust::messages::MessagesRequestBody;
//!
//! let model = ClaudeModel::Claude3Sonnet20240229;
//! let max_tokens = MaxTokens::new(1024, model).unwrap();
//!
//! let request_body = MessagesRequestBody {
//! model,
//! max_tokens,
//! ..Default::default()
//! };
//! ```
//!
//! ### Prompt
//! You can specify the system prompt by `clust::messages::SystemPrompt` and there is no "system" role in the message.
//!
//! ```rust
//! use clust::messages::SystemPrompt;
//! use clust::messages::MessagesRequestBody;
//!
//! let system_prompt = SystemPrompt::new("You are an excellent AI assistant.");
//!
//! let request_body = MessagesRequestBody {
//! system: Some(system_prompt),
//! ..Default::default()
//! };
//! ```
//!
//! ### Messages and contents
//! Build messages by a vector of `clust::messages::Message`:
//!
//! ```rust
//! use clust::messages::Role;
//! use clust::messages::Content;
//!
//! /// The message.
//! pub struct Message {
//! /// The role of the message.
//! pub role: Role,
//! /// The content of the message.
//! pub content: Content,
//! }
//! ```
//!
//! You can create each role message as follows:
//!
//! ```rust
//! use clust::messages::Message;
//!
//! let message = Message::user("Hello, Claude!");
//! let message = Message::assistant("Hello, user!");
//! ```
//!
//! and a content: `clust::messages::Content`.
//!
//! ```rust
//! use clust::messages::ContentBlock;
//!
//! /// The content of the message.
//! pub enum Content {
//! /// The single text content.
//! SingleText(String),
//! /// The multiple content blocks.
//! MultipleBlocks(Vec<ContentBlock>),
//! }
//! ```
//!
//! Multiple blocks is a vector of content block: `clust::messages::ContentBlock`:
//!
//! ```rust
//! use clust::messages::TextContentBlock;
//! use clust::messages::ImageContentBlock;
//!
//! /// The content block of the message.
//! pub enum ContentBlock {
//! /// The text content block.
//! Text(TextContentBlock),
//! /// The image content block.
//! Image(ImageContentBlock),
//! }
//! ```
//!
//! You can create a content as follows:
//!
//! ```rust
//! use clust::messages::Content;
//! use clust::messages::ContentBlock;
//! use clust::messages::TextContentBlock;
//! use clust::messages::ImageContentBlock;
//! use clust::messages::ImageContentSource;
//! use clust::messages::ImageMediaType;
//!
//! // Single text content
//! let content = Content::SingleText("Hello, Claude!".to_string());
//! // or use `From` trait
//! let content = Content::from("Hello, Claude!");
//!
//! // Multiple content blocks
//! let content = Content::MultipleBlocks(vec![
//! ContentBlock::Text(TextContentBlock::new("Hello, Claude!")),
//! ContentBlock::Image(ImageContentBlock::new(ImageContentSource::base64(
//! ImageMediaType::Png,
//! "Base64 encoded image data",
//! ))),
//! ]);
//! // or use `From` trait for `String` or `ImageContentSource`
//! let content = Content::from(vec![
//! ContentBlock::from("Hello, Claude!"),
//! ContentBlock::from(ImageContentSource::base64(
//! ImageMediaType::Png,
//! "Base64 encoded image data",
//! )),
//! ]);
//!
//! ```
//!
//! ### Request body
//! The request body is defined by `clust::messages::MessagesRequestBody`.
//!
//! ```rust
//! use clust::messages::MessagesRequestBody;
//! use clust::messages::ClaudeModel;
//! use clust::messages::Message;
//! use clust::messages::MaxTokens;
//! use clust::messages::SystemPrompt;
//!
//! let request_body = MessagesRequestBody {
//! model: ClaudeModel::Claude3Sonnet20240229,
//! messages: vec![Message::user("Hello, Claude!")],
//! max_tokens: MaxTokens::new(1024, ClaudeModel::Claude3Sonnet20240229).unwrap(),
//! system: Some(SystemPrompt::new("You are an excellent AI assistant.")),
//! ..Default::default()
//! };
//! ```
//!
//! You can also use the builder pattern with `clust::messages::MessagesRequestBuilder`:
//!
//! ```rust
//! use clust::messages::MessagesRequestBuilder;
//! use clust::messages::ClaudeModel;
//! use clust::messages::Message;
//! use clust::messages::SystemPrompt;
//!
//! let request_body = MessagesRequestBuilder::new_with_max_tokens(
//! ClaudeModel::Claude3Sonnet20240229,
//! 1024,
//! ).unwrap()
//! .messages(vec![Message::user("Hello, Claude!")])
//! .system(SystemPrompt::new("You are an excellent AI assistant."))
//! .build();
//! ```
//!
//! ### API calling
//! Call the API by `clust::Client::create_a_message` with the request body.
//!
//! ```rust,no_run
//! use clust::Client;
//! use clust::messages::MessagesRequestBody;
//!
//! #[tokio::main]
//! async fn main() -> anyhow::Result<()> {
//! let client = Client::from_env()?;
//! let request_body = MessagesRequestBody::default();
//!
//! // Call the async API.
//! let response = client
//! .create_a_message(request_body)
//! .await?;
//!
//! // You can extract the text content from `clust::messages::MessagesResponseBody.content.flatten_into_text()`.
//! println!("Content: {}", response.content.flatten_into_text()?);
//!
//! Ok(())
//! }
//! ```
//!
//! ### Streaming
//! When you want to stream the response incrementally,
//! you can use `clust::Client::create_a_message_stream` with the stream option: `StreamOption::ReturnStream`.
//!
//! ```rust,no_run
//! use clust::Client;
//! use clust::messages::MessagesRequestBody;
//! use clust::messages::StreamOption;
//!
//! use tokio_stream::StreamExt;
//!
//! #[tokio::main]
//! async fn main() -> anyhow::Result<()> {
//! let client = Client::from_env()?;
//! let request_body = MessagesRequestBody {
//! stream: Some(StreamOption::ReturnStream),
//! ..Default::default()
//! };
//!
//! // Call the async API and get the stream.
//! let mut stream = client
//! .create_a_message_stream(request_body)
//! .await?;
//!
//! // Poll the stream.
//! while let Some(chunk) = stream.next().await {
//! // Handle the chunk.
//! }
//!
//! Ok(())
//! }
//! ```
//!
//! ### Tool use
//!
//! Support [tool use](https://docs.anthropic.com/en/docs/build-with-claude/tool-use) for two methods:
//!
//! #### 1. Use `clust_tool` attribute macro for Rust function
//!
//! When you define a tool as Rust function with documentation comment like this:
//!
//! ```rust,no_run
//! /// Get the current weather in a given location
//! ///
//! /// ## Arguments
//! /// - `location` - The city and state, e.g. San Francisco, CA
//! fn get_weather(location: String) -> String {
//! "15 degrees".to_string() // Dummy response
//! }
//! ```
//!
//! you can use the `clust::clust_macros::clust_tool` attribute macro with `macros` feature flag to generate code:
//!
//! ```rust,no_run
//! /// Get the current weather in a given location
//! ///
//! /// ## Arguments
//! /// - `location` - The city and state, e.g. San Francisco, CA
//! #[clust_tool] // <- Generate `clust::messages::Tool` for this function
//! fn get_weather(location: String) -> String {
//! "15 degrees".to_string() // Dummy response
//! }
//! ```
//!
//! and create an instance of `clust::messages::Tool` that named by `ClustTool_{function_name}` from the function:
//!
//! ```rust,no_run
//! let tool = ClustTool_get_weather {};
//! ```
//!
//! Get the tool definition from `clust::messages::Tool` for API request:
//!
//! ```rust,no_run
//! let tool_definition = tool.definition();
//! ```
//!
//! and call the tool with tool use got from the API response:
//!
//! ```rust,no_run
//! let tool_result = tool.call(tool_use);
//! ```
//!
//! See also [a tool use example](./examples/tool_use.rs) and [clust_tool](./clust_macros/src/lib.rs) for details.
//!
//! #### 2. Manually implement `clust::messages::Tool` or `clust::messages::AsyncTool`
//!
//! You can manually implement `clust::messages::Tool` or `clust::messages::AsyncTool` for your tool.
//!
//! ## Examples
//!
//! ### Create a message
//! An example of creating a message with the API key loaded from the environment variable: `ANTHROPIC_API_KEY`
//!
//! ```env
//! ANTHROPIC_API_KEY={your-api-key}
//! ```
//!
//! is as follows:
//!
//! ```rust,no_run
//! use clust::messages::ClaudeModel;
//! use clust::messages::MaxTokens;
//! use clust::messages::Message;
//! use clust::messages::MessagesRequestBody;
//! use clust::messages::SystemPrompt;
//! use clust::Client;
//!
//! #[tokio::main]
//! async fn main() -> anyhow::Result<()> {
//! // 1. Create a new API client with the API key loaded from the environment variable: `ANTHROPIC_API_KEY`.
//! let client = Client::from_env()?;
//!
//! // 2. Create a request body.
//! let model = ClaudeModel::Claude3Sonnet20240229;
//! let messages = vec![Message::user(
//! "Where is the capital of France?",
//! )];
//! let max_tokens = MaxTokens::new(1024, model)?;
//! let system_prompt = SystemPrompt::new("You are an excellent AI assistant.");
//! let request_body = MessagesRequestBody {
//! model,
//! messages,
//! max_tokens,
//! system: Some(system_prompt),
//! ..Default::default()
//! };
//!
//! // 3. Call the API.
//! let response = client
//! .create_a_message(request_body)
//! .await?;
//!
//! println!("Result:\n{}", response);
//!
//! Ok(())
//! }
//! ```
//!
//! ### Streaming messages with `tokio` backend
//! An example of creating a message stream with the API key loaded from the environment variable: `ANTHROPIC_API_KEY`
//!
//! ```env
//! ANTHROPIC_API_KEY={your-api-key}
//! ```
//!
//! with [tokio-stream](https://docs.rs/tokio-stream/latest/tokio_stream/) is as follows:
//!
//! ```rust,no_run
//! use clust::messages::ClaudeModel;
//! use clust::messages::MaxTokens;
//! use clust::messages::Message;
//! use clust::messages::MessagesRequestBody;
//! use clust::messages::SystemPrompt;
//! use clust::messages::StreamOption;
//! use clust::messages::MessageChunk;
//! use clust::Client;
//!
//! use tokio_stream::StreamExt;
//!
//! #[tokio::main]
//! async fn main() -> anyhow::Result<()> {
//! // 1. Create a new API client with the API key loaded from the environment variable: `ANTHROPIC_API_KEY`.
//! let client = Client::from_env()?;
//!
//! // 2. Create a request body with `stream` option.
//! let model = ClaudeModel::Claude3Sonnet20240229;
//! let messages = vec![Message::user(
//! "Where is the capital of France?",
//! )];
//! let max_tokens = MaxTokens::new(1024, model)?;
//! let system_prompt = SystemPrompt::new("You are an excellent AI assistant.");
//! let request_body = MessagesRequestBody {
//! model,
//! messages,
//! max_tokens,
//! system: Some(system_prompt),
//! stream: Some(StreamOption::ReturnStream),
//! ..Default::default()
//! };
//!
//! // 3. Call the streaming API.
//! let mut stream = client
//! .create_a_message_stream(request_body)
//! .await?;
//!
//! let mut buffer = String::new();
//!
//! // 4. Poll the stream.
//! // NOTE: The `futures_util::StreamExt` run on the single thread.
//! while let Some(chunk) = stream.next().await {
//! match chunk {
//! | Ok(chunk) => {
//! println!("Chunk:\n{}", chunk);
//! match chunk {
//! | MessageChunk::ContentBlockDelta(content_block_delta) => {
//! // Buffer message delta.
//! buffer.push_str(&content_block_delta.delta.text);
//! }
//! | _ => {}
//! }
//! }
//! | Err(error) => {
//! eprintln!("Chunk error:\n{:?}", error);
//! }
//! }
//! }
//!
//! println!("Result:\n{}", buffer);
//!
//! Ok(())
//! }
//! ```
//!
//! ### Create a message with vision
//!
//! See [an example with vision](./examples/create_a_message_with_vision.rs).
//!
//! ### Conversation
//!
//! See [a conversation example](./examples/conversation.rs).
//!
//! ### Tool use
//!
//! See [a tool use example](./examples/tool_use.rs).
//!
//! ### Other examples
//!
//! See also the [examples](./examples) directory for more examples.
mod api_key;
mod beta;
mod client;
mod error;
mod version;
pub(crate) mod macros;
pub mod messages;
#[cfg(feature = "macros")]
pub mod attributes;
pub use api_key::ApiKey;
pub use beta::Beta;
pub use client::Client;
pub use client::ClientBuilder;
pub use error::ApiError;
pub use error::ApiErrorBody;
pub use error::ApiErrorResponse;
pub use error::ApiErrorType;
pub use error::ClientError;
pub use error::ValidationError;
pub use version::Version;
pub use futures_core;
pub use reqwest;
pub use serde_json;
#[cfg(feature = "macros")]
pub use clust_macros;