zach
Add minor improvement to Anthropic exception
fa43e81
raw
history blame
6.42 kB
"""
anthropic_api.py
This file defines the interaction with the Anthropic API, focusing on generating text
using the Claude model. It includes functionality for input validation, API request handling,
and processing API responses.
Key Features:
- Encapsulates all logic related to the Anthropic API.
- Implements retry logic for handling transient API errors.
- Validates the response content to ensure API compatibility.
- Provides detailed logging for debugging and error tracking.
Classes:
- AnthropicError: Custom exception for Anthropic API-related errors.
- SystemPrompt: Frozen dataclass for storing the system prompt, ensuring immutability.
Functions:
- generate_text_with_claude: Generates text using the Anthropic SDK with input validation and retry logic.
"""
# Standard Library Imports
from dataclasses import dataclass
import logging
from typing import List, Optional, Union
# Third-Party Library Imports
from anthropic import Anthropic
from anthropic.types import Message, ModelParam, TextBlock
from tenacity import retry, stop_after_attempt, wait_fixed, before_log, after_log
# Local Application Imports
from src.config import logger
from src.utils import truncate_text, validate_env_var
@dataclass(frozen=True)
class AnthropicConfig:
"""
Immutable configuration for interacting with the Anthropic API.
Includes client initialization for encapsulation.
"""
api_key: str = validate_env_var("ANTHROPIC_API_KEY")
model: ModelParam = "claude-3-5-sonnet-latest" # Valid predefined model
max_tokens: int = 300 # Max tokens for API response
system_prompt: str = """You are a highly creative and articulate assistant specialized in generating vivid, engaging, and well-written content.
Your task is to respond to user prompts by creating:
1. Short stories,
2. Poems,
3. Or other creative written outputs.
Ensure that your responses are:
- Imaginative and original,
- Coherent and well-structured,
- Suitable for a wide audience, avoiding controversial or sensitive topics.
When writing, tailor your tone and style to match the user's request. For example:
- If the user requests a poem, provide creative and rhythmic verse.
- If the user requests a short story, ensure a clear beginning, middle, and end with compelling details.
Always keep your responses concise, unless explicitly instructed to elaborate."""
def __post_init__(self):
# Validate that required attributes are set
if not self.api_key:
raise ValueError("Anthropic API key is not set.")
if not self.model:
raise ValueError("Anthropic Model is not set.")
if not self.max_tokens:
raise ValueError("Anthropic Max Tokens is not set.")
if not self.system_prompt:
raise ValueError("Anthropic System Prompt is not set.")
@property
def client(self) -> Anthropic:
"""
Lazy initialization of the Anthropic client.
Returns:
Anthropic: Configured client instance.
"""
return Anthropic(api_key=self.api_key)
class AnthropicError(Exception):
"""Custom exception for errors related to the Anthropic API."""
def __init__(self, message: str, original_exception: Optional[Exception] = None):
super().__init__(message)
self.original_exception = original_exception
# Initialize the Anthropic client
anthropic_config = AnthropicConfig()
@retry(
stop=stop_after_attempt(3),
wait=wait_fixed(2),
before=before_log(logger, logging.DEBUG),
after=after_log(logger, logging.DEBUG),
)
def generate_text_with_claude(prompt: str) -> str:
"""
Generates text using Claude via the Anthropic SDK.
Args:
prompt (str): The input prompt for Claude.
Returns:
str: The generated text.
Raises:
ValueError: If the prompt exceeds the maximum allowed length.
AnthropicError: If there is an error communicating with the Anthropic API.
Example:
>>> generate_text_with_claude("Write a haiku about nature.")
"Gentle waves crashing, / Whispering secrets softly, / Infinite blue skies."
>>> generate_text_with_claude("")
"The prompt exceeds the maximum allowed length of 500 characters. Your prompt contains 512 characters."
"""
# Log model, max tokens, and system prompt for debugging
logger.debug(f"Using model: {anthropic_config.model}, max tokens: {anthropic_config.max_tokens}")
logger.debug(f"System prompt: {truncate_text(anthropic_config.system_prompt)}")
logger.debug(f"Preparing API request with prompt: {prompt[:50]}{'...' if len(prompt) > 50 else ''}")
try:
response: Message = anthropic_config.client.messages.create(
model=anthropic_config.model,
max_tokens=anthropic_config.max_tokens,
system=anthropic_config.system_prompt,
messages=[{"role": "user", "content": prompt}],
)
logger.debug(f"API response received: {truncate_text(str(response))}")
# Validate response content
if not hasattr(response, "content"):
logger.error("Response is missing 'content'. Response: %s", response)
raise AnthropicError("Invalid API response: Missing 'content'.")
# Process response content
blocks: Union[List[TextBlock], TextBlock, None] = response.content
if isinstance(blocks, list):
result = "\n\n".join(block.text for block in blocks if isinstance(block, TextBlock))
logger.debug(f"Processed response from list: {truncate_text(result)}")
return result
if isinstance(blocks, TextBlock):
logger.debug(f"Processed response from single TextBlock: {truncate_text(blocks.text)}")
return blocks.text
logger.warning(f"Unexpected response type: {type(blocks)}")
return str(blocks or "No content generated.")
except Exception as e:
logger.exception(f"Error generating text with Claude: {e}")
raise AnthropicError(
message=(
f"Error generating text with Claude: {e}. "
f"HTTP Status: {getattr(response, 'status', 'N/A')}. "
f"Prompt (truncated): {truncate_text(prompt)}. "
f"Model: {anthropic_config.model}, Max tokens: {anthropic_config.max_tokens}"
),
original_exception=e,
)