Package: anthropic-bedrock
Anthropic Bedrock Python API libraryThe Anthropic Bedrock Python library provides convenient access to theAnthropic BedrockREST API from any Python 3.7+
application. It includes type definitions for all request params and response fields,
and offers both synchronous and asynchronous clients powered byhttpx.For the non-Bedrock Anthropic API at api.anthropic.com, seeanthropic-python.DocumentationThe REST API documentation can be foundon docs.anthropic.com. The full API of this library can be found inapi.md.Installationpipinstallanthropic-bedrockUsageThe full API of this library can be found inapi.md.importanthropic_bedrockfromanthropic_bedrockimportAnthropicBedrockclient=AnthropicBedrock(# Authenticate by either providing the keys below or use the default AWS credential providers, such as# using ~/.aws/credentials or the "AWS_SECRET_ACCESS_KEY" and "AWS_ACCESS_KEY_ID" environment variables.aws_access_key="<access key>",aws_secret_key="<secret key>",# Temporary credentials can be used with aws_session_token.# Read more at https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp.html.aws_session_token="<session_token>",# aws_region changes the aws region to which the request is made. By default, we read AWS_REGION,# and if that's not present, we default to us-east-1. Note that we do not read ~/.aws/config for the region.aws_region="us-east-2",)completion=client.completions.create(model="anthropic.claude-v2:1",max_tokens_to_sample=256,prompt=f"{anthropic_bedrock.HUMAN_PROMPT}how does a court case get to the Supreme Court?{anthropic_bedrock.AI_PROMPT}",)print(completion.completion)This library usesbotocoreinternally for authentication; you can read more about the default providershere.Async usageSimply importAsyncAnthropicBedrockinstead ofAnthropicBedrockand useawaitwith each API call:importanthropic_bedrockfromanthropic_bedrockimportAsyncAnthropicBedrockclient=AsyncAnthropicBedrock()asyncdefmain():completion=awaitclient.completions.create(model="anthropic.claude-v2:1",max_tokens_to_sample=256,prompt=f"{anthropic_bedrock.HUMAN_PROMPT}how does a court case get to the Supreme Court?{anthropic_bedrock.AI_PROMPT}",)print(completion.completion)asyncio.run(main())Functionality between the synchronous and asynchronous clients is otherwise identical.Streaming ResponsesWe provide support for streaming responses using Server Side Events (SSE).fromanthropic_bedrockimportAnthropicBedrock,HUMAN_PROMPT,AI_PROMPTclient=AnthropicBedrock()stream=client.completions.create(prompt=f"{HUMAN_PROMPT}Your prompt here{AI_PROMPT}",max_tokens_to_sample=300,model="anthropic.claude-v2:1",stream=True,)forcompletioninstream:print(completion.completion,end="",flush=True)The async client uses the exact same interface.fromanthropic_bedrockimportAsyncAnthropicBedrock,HUMAN_PROMPT,AI_PROMPTclient=AsyncAnthropicBedrock()stream=awaitclient.completions.create(prompt=f"{HUMAN_PROMPT}Your prompt here{AI_PROMPT}",max_tokens_to_sample=300,model="anthropic.claude-v2:1",stream=True,)asyncforcompletioninstream:print(completion.completion,end="",flush=True)Using typesNested request parameters areTypedDicts. Responses arePydantic models, which provide helper methods for things like:Serializing back into JSON,model.model_dump_json(indent=2, exclude_unset=True)Converting to a dictionary,model.model_dump(exclude_unset=True)Typed requests and responses provide autocomplete and documentation within your editor. If you would like to see type errors in VS Code to help catch bugs earlier, setpython.analysis.typeCheckingModetobasic.Token countingYou can estimate billing for a given request with theclient.count_tokens()method, eg:client=AnthropicBedrock()client.count_tokens('Hello world!')# 3Handling errorsWhen the library is unable to connect to the API (for example, due to network connection problems or a timeout), a subclass ofanthropic_bedrock.APIConnectionErroris raised.When the API returns a non-success status code (that is, 4xx or 5xx
response), a subclass ofanthropic_bedrock.APIStatusErroris raised, containingstatus_codeandresponseproperties.All errors inherit fromanthropic_bedrock.APIError.importanthropic_bedrockfromanthropic_bedrockimportAnthropicBedrockclient=AnthropicBedrock()try:client.completions.create(prompt=f"{anthropic_bedrock.HUMAN_PROMPT}Your prompt here{anthropic_bedrock.AI_PROMPT}",max_tokens_to_sample=256,model="anthropic.claude-v2:1",)exceptanthropic_bedrock.APIConnectionErrorase:print("The server could not be reached")print(e.__cause__)# an underlying Exception, likely raised within httpx.exceptanthropic_bedrock.RateLimitErrorase:print("A 429 status code was received; we should back off a bit.")exceptanthropic_bedrock.APIStatusErrorase:print("Another non-200-range status code was received")print(e.status_code)print(e.response)Error codes are as followed:Status CodeError Type400BadRequestError401AuthenticationError403PermissionDeniedError404NotFoundError422UnprocessableEntityError429RateLimitError>=500InternalServerErrorN/AAPIConnectionErrorRetriesCertain errors are automatically retried 2 times by default, with a short exponential backoff.
Connection errors (for example, due to a network connectivity problem), 408 Request Timeout, 409 Conflict,
429 Rate Limit, and >=500 Internal errors are all retried by default.You can use themax_retriesoption to configure or disable retry settings:fromanthropic_bedrockimportAnthropicBedrock,HUMAN_PROMPT,AI_PROMPT# Configure the default for all requests:client=AnthropicBedrock(# default is 2max_retries=0,)# Or, configure per-request:client.with_options(max_retries=5).completions.create(prompt=f"{HUMAN_PROMPT}Can you help me effectively ask for a raise at work?{AI_PROMPT}",max_tokens_to_sample=300,model="anthropic.claude-v2:1",)TimeoutsBy default requests time out after 10 minutes. You can configure this with atimeoutoption,
which accepts a float or anhttpx.Timeoutobject:fromanthropic_bedrockimportAnthropicBedrock,HUMAN_PROMPT,AI_PROMPT# Configure the default for all requests:client=AnthropicBedrock(# default is 10 minutestimeout=20.0,)# More granular control:client=AnthropicBedrock(timeout=httpx.Timeout(60.0,read=5.0,write=10.0,connect=2.0),)# Override per-request:client.with_options(timeout=5*1000).completions.create(prompt=f"{HUMAN_PROMPT}Where can I get a good coffee in my neighbourhood?{AI_PROMPT}",max_tokens_to_sample=300,model="anthropic.claude-v2:1",)On timeout, anAPITimeoutErroris thrown.Note that requests that time out areretried twice by default.AdvancedLoggingWe use the standard libraryloggingmodule.You can enable logging by setting the environment variableANTHROPIC_BEDROCK_LOGtodebug.$exportANTHROPIC_BEDROCK_LOG=debugHow to tell whetherNonemeansnullor missingIn an API response, a field may be explicitlynull, or missing entirely; in either case, its value isNonein this library. You can differentiate the two cases with.model_fields_set:ifresponse.my_fieldisNone:if'my_field'notinresponse.model_fields_set:print('Got json like{}, without a "my_field" key present at all.')else:print('Got json like {"my_field": null}.')Accessing raw response data (e.g. headers)The "raw" Response object can be accessed by prefixing.with_raw_response.to any HTTP method call, e.g.,fromanthropic_bedrockimportAnthropicBedrock,HUMAN_PROMPT,AI_PROMPTclient=AnthropicBedrock()response=client.completions.with_raw_response.create(prompt=f"{HUMAN_PROMPT}Your prompt here{AI_PROMPT}",max_tokens_to_sample=300,model="anthropic.claude-v2:1",)print(response.headers.get('X-My-Header'))completion=response.parse()# get the object that `completions.create()` would have returnedprint(completion.completion)These methods return anLegacyAPIResponseobject. This is a legacy class as we're changing it slightly in the next major version.For the sync client this will mostly be the same with the exception
ofcontent&textwill be methods instead of properties. In the
async client, all methods will be async.A migration script will be provided & the migration in general should
be smooth..with_streaming_responseThe above interface eagerly reads the full response body when you make the request, which may not always be what you want.To stream the response body, use.with_streaming_responseinstead, which requires a context manager and only reads the response body once you call.read(),.text(),.json(),.iter_bytes(),.iter_text(),.iter_lines()or.parse(). In the async client, these are async methods.As such,.with_streaming_responsemethods return a differentAPIResponseobject, and the async client returns anAsyncAPIResponseobject.withclient.completions.with_streaming_response.create(max_tokens_to_sample=300,model="claude-2.1",prompt=f"{HUMAN_PROMPT}Where can I get a good coffee in my neighbourhood?{AI_PROMPT}",)asresponse:print(response.headers.get("X-My-Header"))forlineinresponse.iter_lines():print(line)The context manager is required so that the response will reliably be closed.Configuring the HTTP clientYou can directly override thehttpx clientto customize it for your use case, including:Support for proxiesCustom transportsAdditionaladvancedfunctionalityimporthttpxfromanthropic_bedrockimportAnthropicBedrockclient=AnthropicBedrock(# Or use the `ANTHROPIC_BEDROCK_BASE_URL` env varbase_url="http://my.test.server.example.com:8083",http_client=httpx.Client(proxies="http://my.test.proxy.example.com",transport=httpx.HTTPTransport(local_address="0.0.0.0"),),aws_secret_key="<secret key>",aws_access_key="<access key>",aws_region="us-east-2",)Managing HTTP resourcesBy default the library closes underlying HTTP connections whenever the client isgarbage collected. You can manually close the client using the.close()method if desired, or with a context manager that closes when exiting.VersioningThis package generally followsSemVerconventions, though certain backwards-incompatible changes may be released as minor versions:Changes that only affect static types, without breaking runtime behavior.Changes to library internals which are technically public but not intended or documented for external use.(Please open a GitHub issue to let us know if you are relying on such internals).Changes that we do not expect to impact the vast majority of users in practice.We take backwards-compatibility seriously and work hard to ensure you can rely on a smooth upgrade experience.We are keen for your feedback; please open anissuewith questions, bugs, or suggestions.RequirementsPython 3.7 or higher.