Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .codespellrc
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
[codespell]
skip = .git,*.lock,bun.lockb,node_modules,coverage,dist,cassettes,mlx_lm_cassettes,snapshots,htmlcov,./cloud/docker/data/**,test_caching.py,cloud/clickhouse/search.test.ts
ignore-words-list = afterAll,ROUGE,Rouge,rouge,ue
ignore-words-list = afterAll,ROUGE,Rouge,rouge,ue,aiport,Appen,buyed,AKS,EHR,therefrom
240 changes: 240 additions & 0 deletions cloud/content/docs/v1/api/core/anthropic/call.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,240 @@
---
# AUTO-GENERATED API DOCUMENTATION - DO NOT EDIT
title: mirascope.core.anthropic.call
description: API documentation for mirascope.core.anthropic.call
---

# mirascope.core.anthropic.call

## <ApiType type="Alias" path="core/anthropic/call" symbolName="call" /> call

A decorator for calling the Anthropic API with a typed function.

<Info title="Usage">

[Calls](/docs/mirascope/learn/calls)

</Info>


This decorator is used to wrap a typed function that calls the Anthropic API. It
parses the prompt template of the wrapped function as the messages array and templates
the input arguments for the function into each message's template.

Example:

```python
from mirascope.core import prompt_template
from mirascope.core.anthropic import anthropic_call


@anthropic_call("claude-3-5-sonnet-20240620")
def recommend_book(genre: str) -> str:
return f"Recommend a {genre} book"

response = recommend_book("fantasy")
print(response.content)
```

<ParametersTable
parameters={[
{
"name": "model",
"type_info": {
"type_str": "str",
"description": null,
"kind": "simple",
"doc_url": "https://docs.python.org/3/library/stdtypes.html#str"
},
"description": "The Anthropic model to use in the API call."
},
{
"name": "stream",
"type_info": {
"type_str": "bool",
"description": null,
"kind": "simple",
"doc_url": "https://docs.python.org/3/library/functions.html#bool"
},
"description": "Whether to stream the response from the API call."
},
{
"name": "tools",
"type_info": {
"type_str": "list[BaseTool | Callable]",
"description": null,
"kind": "generic",
"base_type": {
"type_str": "list",
"description": null,
"kind": "simple",
"doc_url": "https://docs.python.org/3/library/stdtypes.html#list"
},
"parameters": [
{
"type_str": "BaseTool | Callable",
"description": null,
"kind": "union",
"base_type": {
"type_str": "Union",
"description": null,
"kind": "simple",
"doc_url": "https://docs.python.org/3/library/typing.html#typing.Union"
},
"parameters": [
{
"type_str": "BaseTool",
"description": null,
"kind": "simple",
"doc_url": "/docs/mirascope/api/core/base/tool#basetool"
},
{
"type_str": "Callable",
"description": null,
"kind": "simple",
"doc_url": "https://docs.python.org/3/library/typing.html#typing.Callable"
}
]
}
]
},
"description": "The tools to use in the Anthropic API call."
},
{
"name": "response_model",
"type_info": {
"type_str": "BaseModel | BaseType",
"description": null,
"kind": "union",
"base_type": {
"type_str": "Union",
"description": null,
"kind": "simple",
"doc_url": "https://docs.python.org/3/library/typing.html#typing.Union"
},
"parameters": [
{
"type_str": "BaseModel",
"description": null,
"kind": "simple",
"doc_url": "https://docs.pydantic.dev/latest/api/base_model/"
},
{
"type_str": "BaseType",
"description": null,
"kind": "simple",
"doc_identifier": "BaseType"
}
]
},
"description": "The response model into which the response\nshould be structured."
},
{
"name": "output_parser",
"type_info": {
"type_str": "Callable[[AnthropicCallResponse | ResponseModelT], Any]",
"description": null,
"kind": "callable",
"base_type": {
"type_str": "Callable",
"description": null,
"kind": "simple",
"doc_url": "https://docs.python.org/3/library/typing.html#typing.Callable"
},
"parameters": [
{
"type_str": "[AnthropicCallResponse | ResponseModelT]",
"description": null,
"kind": "tuple",
"base_type": {
"type_str": "tuple",
"description": null,
"kind": "simple",
"doc_url": "https://docs.python.org/3/library/stdtypes.html#tuple"
},
"parameters": [
{
"type_str": "AnthropicCallResponse | ResponseModelT",
"description": null,
"kind": "union",
"base_type": {
"type_str": "Union",
"description": null,
"kind": "simple",
"doc_url": "https://docs.python.org/3/library/typing.html#typing.Union"
},
"parameters": [
{
"type_str": "AnthropicCallResponse",
"description": null,
"kind": "simple",
"doc_url": "/docs/mirascope/api/core/anthropic/call_response#anthropiccallresponse"
},
{
"type_str": "ResponseModelT",
"description": null,
"kind": "simple",
"doc_identifier": "ResponseModelT"
}
]
}
]
},
{
"type_str": "Any",
"description": null,
"kind": "simple",
"doc_url": "https://docs.python.org/3/library/typing.html#typing.Any"
}
]
},
"description": "A function\nfor parsing the call response whose value will be returned in place of the\noriginal call response."
},
{
"name": "json_mode",
"type_info": {
"type_str": "bool",
"description": null,
"kind": "simple",
"doc_url": "https://docs.python.org/3/library/functions.html#bool"
},
"description": "Whether to use JSON Mode."
},
{
"name": "client",
"type_info": {
"type_str": "object",
"description": null,
"kind": "simple",
"doc_url": "https://docs.python.org/3/library/functions.html#object"
},
"description": "An optional custom client to use in place of the default client."
},
{
"name": "call_params",
"type_info": {
"type_str": "AnthropicCallParams",
"description": null,
"kind": "simple",
"doc_url": "/docs/mirascope/api/core/anthropic/call_params#anthropiccallparams"
},
"description": "The `AnthropicCallParams` call parameters to use\nin the API call."
}
]}
/>

<ReturnTable
returnType={{
"type_info": {
"type_str": "Callable",
"description": null,
"kind": "simple",
"doc_url": "https://docs.python.org/3/library/typing.html#typing.Callable"
},
"description": "The decorator for turning a typed function into an Anthropic\nAPI call."
}}
/>


**Alias to:** `mirascope.core.anthropic._call.anthropic_call`

Loading