anthropic¶
A module for interacting with Anthropic models.
AnthropicCall
¶
Bases: BaseCall[AnthropicCallResponse, AnthropicCallResponseChunk, AnthropicTool]
A base class for calling Anthropic's Claude models.
Example:
from mirascope.anthropic import AnthropicCall
class BookRecommender(AnthropicCall):
prompt_template = "Please recommend a {genre} book."
genre: str
response = BookRecommender(genre="fantasy").call()
print(response.content)
#> There are many great books to read, it ultimately depends...
Source code in mirascope/anthropic/calls.py
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 |
|
call(retries=1, **kwargs)
¶
Makes a call to the model using this AnthropicCall
instance.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
**kwargs |
Any
|
Additional keyword arguments parameters to pass to the call. These
will override any existing arguments in |
{}
|
Returns:
Type | Description |
---|---|
AnthropicCallResponse
|
A |
Source code in mirascope/anthropic/calls.py
call_async(retries=1, **kwargs)
async
¶
Makes an asynchronous call to the model using this AnthropicCall
instance.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
**kwargs |
Any
|
Additional keyword arguments parameters to pass to the call. These
will override any existing arguments in |
{}
|
Returns:
Type | Description |
---|---|
AnthropicCallResponse
|
A |
Source code in mirascope/anthropic/calls.py
messages()
¶
Returns the template as a formatted list of messages.
stream(retries=1, **kwargs)
¶
Streams the response for a call using this AnthropicCall
.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
**kwargs |
Any
|
Additional keyword arguments parameters to pass to the call. These
will override any existing arguments in |
{}
|
Yields:
Type | Description |
---|---|
AnthropicCallResponseChunk
|
An |
Source code in mirascope/anthropic/calls.py
stream_async(retries=1, **kwargs)
async
¶
Streams the response for an asynchronous call using this AnthropicCall
.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
**kwargs |
Any
|
Additional keyword arguments parameters to pass to the call. These
will override any existing arguments in |
{}
|
Yields:
Type | Description |
---|---|
AsyncGenerator[AnthropicCallResponseChunk, None]
|
An |
Source code in mirascope/anthropic/calls.py
AnthropicCallParams
¶
Bases: BaseCallParams[AnthropicTool]
The parameters to use when calling d Claud API with a prompt.
Example:
from mirascope.anthropic import AnthropicCall, AnthropicCallParams
class BookRecommender(AnthropicCall):
prompt_template = "Please recommend some books."
call_params = AnthropicCallParams(
model="anthropic-3-opus-20240229",
)
Source code in mirascope/anthropic/types.py
kwargs(tool_type=None, exclude=None)
¶
Returns the keyword argument call parameters.
Source code in mirascope/anthropic/types.py
AnthropicCallResponse
¶
Bases: BaseCallResponse[Union[Message, ToolsBetaMessage], AnthropicTool]
Convenience wrapper around the Anthropic Claude API.
When using Mirascope's convenience wrappers to interact with Anthropic models via
AnthropicCall
, responses using Anthropic.call()
will return an
AnthropicCallResponse
, whereby the implemented properties allow for simpler syntax
and a convenient developer experience.
Example:
from mirascope.anthropic import AnthropicCall
class BookRecommender(AnthropicCall):
prompt_template = "Please recommend some books."
print(BookRecommender().call())
Source code in mirascope/anthropic/types.py
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 |
|
AnthropicCallResponseChunk
¶
Bases: BaseCallResponseChunk[MessageStreamEvent, AnthropicTool]
Convenience wrapper around the Anthropic API streaming chunks.
When using Mirascope's convenience wrappers to interact with Anthropic models via
AnthropicCall
, responses using AnthropicCall.stream()
will yield
AnthropicCallResponseChunk
, whereby the implemented properties allow for simpler
syntax and a convenient developer experience.
Example:
from mirascope.anthropic import AnthropicCall
class BookRecommender(AnthropicCall):
prompt_template = "Please recommend some books."
for chunk in BookRecommender().stream():
print(chunk, end="")
Source code in mirascope/anthropic/types.py
AnthropicExtractor
¶
Bases: BaseExtractor[AnthropicCall, AnthropicTool, Any, T]
, Generic[T]
A class for extracting structured information using Anthropic Claude models.
Example:
from typing import Literal, Type
from mirascope.anthropic import AnthropicExtractor
from pydantic import BaseModel
class TaskDetails(BaseModel):
title: str
priority: Literal["low", "normal", "high"]
due_date: str
class TaskExtractor(AnthropicExtractor[TaskDetails]):
extract_schema: Type[TaskDetails] = TaskDetails
prompt_template = """
Please extract the task details:
{task}
"""
task: str
task_description = "Submit quarterly report by next Friday. Task is high priority."
task = TaskExtractor(task=task_description).extract(retries=3)
assert isinstance(task, TaskDetails)
print(task)
#> title='Submit quarterly report' priority='high' due_date='next Friday'
Source code in mirascope/anthropic/extractors.py
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 |
|
extract(retries=0, **kwargs)
¶
Extracts extract_schema
from the Anthropic call response.
The extract_schema
is converted into an AnthropicTool
, complete with a
description of the tool, all of the fields, and their types. This allows us to
take advantage of Anthropics's tool/function calling functionality to extract
information from a prompt according to the context provided by the BaseModel
schema.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
retries |
Union[int, Retrying]
|
The maximum number of times to retry the query on validation error. |
0
|
**kwargs |
Any
|
Additional keyword arguments parameters to pass to the call. These
will override any existing arguments in |
{}
|
Returns:
Type | Description |
---|---|
T
|
The |
Raises:
Type | Description |
---|---|
AttributeError
|
if there is no tool in the call creation. |
ValidationError
|
if the schema cannot be instantiated from the completion. |
Source code in mirascope/anthropic/extractors.py
extract_async(retries=0, **kwargs)
async
¶
Asynchronously extracts extract_schema
from the Anthropic call response.
The extract_schema
is converted into an AnthropicTool
, complete with a
description of the tool, all of the fields, and their types. This allows us to
take advantage of Anthropic's tool/function calling functionality to extract
information from a prompt according to the context provided by the BaseModel
schema.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
retries |
Union[int, AsyncRetrying]
|
The maximum number of times to retry the query on validation error. |
0
|
**kwargs |
Any
|
Additional keyword arguments parameters to pass to the call. These
will override any existing arguments in |
{}
|
Returns:
Type | Description |
---|---|
T
|
The |
Raises:
Type | Description |
---|---|
AttributeError
|
if there is no tool in the call creation. |
ValidationError
|
if the schema cannot be instantiated from the completion. |
Source code in mirascope/anthropic/extractors.py
stream(retries=0, **kwargs)
¶
Streams partial instances of extract_schema
as the schema is streamed.
The extract_schema
is converted into a partial(AnthropicTool)
, which allows
for any field (i.e.function argument) in the tool to be None
. This allows us
to stream partial results as we construct the tool from the streamed chunks.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
retries |
Union[int, Retrying]
|
The maximum number of times to retry the query on validation error. |
0
|
**kwargs |
Any
|
Additional keyword argument parameters to pass to the call. These
will override any existing arguments in |
{}
|
Yields:
Type | Description |
---|---|
T
|
The partial |
Raises:
Type | Description |
---|---|
AttributeError
|
if there is no tool in the call creation. |
ValidationError
|
if the schema cannot be instantiated from the completion. |
Source code in mirascope/anthropic/extractors.py
stream_async(retries=0, **kwargs)
async
¶
Asynchronously streams partial instances of extract_schema
as streamed.
The extract_schema
is converted into a partial(AnthropicTool)
, which allows
for any field (i.e.function argument) in the tool to be None
. This allows us
to stream partial results as we construct the tool from the streamed chunks.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
retries |
Union[int, AsyncRetrying]
|
The maximum number of times to retry the query on validation error. |
0
|
**kwargs |
Any
|
Additional keyword arguments parameters to pass to the call. These
will override any existing arguments in |
{}
|
Yields:
Type | Description |
---|---|
AsyncGenerator[T, None]
|
The partial |
Raises:
Type | Description |
---|---|
AttributeError
|
if there is no tool in the call creation. |
ValidationError
|
if the schema cannot be instantiated from the completion. |
Source code in mirascope/anthropic/extractors.py
AnthropicTool
¶
Bases: BaseTool[ToolUseBlock]
A base class for easy use of tools with the Anthropic Claude client.
AnthropicTool
internally handles the logic that allows you to use tools with
simple calls such as AnthropicCallResponse.tool
or AnthropicTool.fn
, as seen in
the example below.
Example:
from mirascope import AnthropicCall, AnthropicCallParams
def animal_matcher(fav_food: str, fav_color: str) -> str:
"""Tells you your most likely favorite animal from personality traits.
Args:
fav_food: your favorite food.
fav_color: your favorite color.
Returns:
The animal most likely to be your favorite based on traits.
"""
return "Your favorite animal is the best one, a frog."
class AnimalMatcher(AnthropicCall):
prompt_template = """
Tell me my favorite animal if my favorite food is {food} and my
favorite color is {color}.
"""
food: str
color: str
call_params = AnthropicCallParams(tools=[animal_matcher])
response = AnimalMatcher(food="pizza", color="red").call
tool = response.tool
print(tool.fn(**tool.args))
#> Your favorite animal is the best one, a frog.
Source code in mirascope/anthropic/tools.py
from_base_type(base_type)
classmethod
¶
Constructs a AnthropicTool
type from a BaseType
type.
from_fn(fn)
classmethod
¶
from_model(model)
classmethod
¶
Constructs a AnthropicTool
type from a BaseModel
type.
from_tool_call(tool_call)
classmethod
¶
Extracts an instance of the tool constructed from a tool call response.
Given the tool call contents in a Message
from an Anthropic call response,
this method parses out the arguments of the tool call and creates an
AnthropicTool
instance from them.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
tool_call |
ToolUseBlock
|
The list of |
required |
Returns:
Type | Description |
---|---|
AnthropicTool
|
An instance of the tool constructed from the tool call. |
Raises:
Type | Description |
---|---|
ValidationError
|
if the tool call doesn't match the tool schema. |
Source code in mirascope/anthropic/tools.py
tool_schema()
classmethod
¶
Constructs JSON tool schema for use with Anthropic's Claude API.
Source code in mirascope/anthropic/tools.py
AnthropicToolStream
¶
Bases: BaseToolStream[AnthropicCallResponseChunk, AnthropicTool]
A base class for streaming tools from response chunks.
Source code in mirascope/anthropic/tool_streams.py
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 |
|
from_async_stream(async_stream, allow_partial=False)
async
classmethod
¶
Yields partial tools from the given stream of chunks asynchronously.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
stream |
The async generator of chunks from which to stream tools. |
required | |
allow_partial |
Whether to allow partial tools. |
False
|
Raises:
Type | Description |
---|---|
RuntimeError
|
if a tool in the stream is of an unknown type. |
Source code in mirascope/anthropic/tool_streams.py
from_stream(stream, allow_partial=False)
classmethod
¶
Yields partial tools from the given stream of chunks.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
stream |
The generator of chunks from which to stream tools. |
required | |
allow_partial |
Whether to allow partial tools. |
False
|
Raises:
Type | Description |
---|---|
RuntimeError
|
if a tool in the stream is of an unknown type. |
Source code in mirascope/anthropic/tool_streams.py
anthropic_api_calculate_cost(usage, model='claude-3-haiku-20240229')
¶
Calculate the cost of a completion using the Anthropic API.
https://www.anthropic.com/api
claude-instant-1.2 $0.80 / 1M tokens $2.40 / 1M tokens claude-2.0 $8.00 / 1M tokens $24.00 / 1M tokens claude-2.1 $8.00 / 1M tokens $24.00 / 1M tokens claude-3-haiku $0.25 / 1M tokens $1.25 / 1M tokens claude-3-sonnet $3.00 / 1M tokens $15.00 / 1M tokens claude-3-opus $15.00 / 1M tokens $75.00 / 1M tokens