Skip to main content

A utility to force AWS Bedrock to apply the given syntax to its response.

Project description

Bedrock Syntaxer

A utility to force AWS Bedrock to apply the given syntax to its response.

Installation

To install the required dependencies, run:

pip install -r requirements.txt

Usage

Function: bedrock_syntaxer

A utility to force Bedrock to apply the given syntax to its response.

Parameters:

  • model_id (str): The model ID of the Bedrock model.
  • messages (list): The messages to send to Bedrock.
  • syntax (str): The syntax to apply to the response.
  • inference_config (dict, optional): The inference configuration to use.
  • region_name (str, optional): The region name of the Bedrock model.

Returns:

  • str: The response from Bedrock with the syntax applied.

Example

from bedrock_syntaxer import bedrock_syntaxer
import json

ACCOUNT_ID = "961341532715"
REGION = "us-east-1"
MODEL_NAME = "claude-3-5-sonnet-20241022-v2:0"
MODEL_ID = f"arn:aws:bedrock:{REGION}:{ACCOUNT_ID}:inference-profile/us.anthropic.{MODEL_NAME}"

prompt = (
    "Write the definition of 3 Filipino word in JSON format. "
    "The words are 'kamusta', 'salamat', and 'paalam'."
    "Use the keys 'word' and 'definition'."
)
messages = [{"role": "user", "content": [{"text": prompt}]}]

response = bedrock_syntaxer(
    model_id=MODEL_ID,
    messages=messages,
    syntax="json",
    region_name=REGION,
)

print(response)

# The response is a JSON string.
response_json = json.loads(response)

Testing

To run the tests, use:

pytest

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

bedrock_syntaxer-0.2.0.tar.gz (2.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

bedrock_syntaxer-0.2.0-py3-none-any.whl (3.7 kB view details)

Uploaded Python 3

File details

Details for the file bedrock_syntaxer-0.2.0.tar.gz.

File metadata

  • Download URL: bedrock_syntaxer-0.2.0.tar.gz
  • Upload date:
  • Size: 2.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.0.1 CPython/3.13.0 Darwin/24.3.0

File hashes

Hashes for bedrock_syntaxer-0.2.0.tar.gz
Algorithm Hash digest
SHA256 ae4f37162fa0b69b67158451b9e16f1fbd8898badc9dae5cfcb1002056d7158a
MD5 832e3b0a9146727df6e05323f7d9956e
BLAKE2b-256 3d262160133d9365e9870928217760fed2b9ef8f41dbfbb9146037d09c5f5b5f

See more details on using hashes here.

File details

Details for the file bedrock_syntaxer-0.2.0-py3-none-any.whl.

File metadata

  • Download URL: bedrock_syntaxer-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 3.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.0.1 CPython/3.13.0 Darwin/24.3.0

File hashes

Hashes for bedrock_syntaxer-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 77793f0f45ec2065e8ae1319e926a2fe510e78eb732fb9ecd2085d5a03ecaeaa
MD5 04f5043aaaab558dfb5e4f487eb3f76b
BLAKE2b-256 c35cf5aacd75429b5f507e55ae2c235ecf5a18ef1dfe8db1b2929962774e1283

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page