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.1.0.tar.gz (2.8 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.1.0-py3-none-any.whl (3.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: bedrock_syntaxer-0.1.0.tar.gz
  • Upload date:
  • Size: 2.8 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.1.0.tar.gz
Algorithm Hash digest
SHA256 d4421d4edfbe12f25a25c9c310fb89692dfc8dd5fa5a379fcb3548674fa772aa
MD5 1fa8cee72dd8e2cacaa71a33a8244fec
BLAKE2b-256 323e2413784fa371f99cf96f4a25e54b8ab3b4fed80c2bd0c8b66122ea261b8e

See more details on using hashes here.

File details

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

File metadata

  • Download URL: bedrock_syntaxer-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 3.6 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.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 00b5aa26a8dfb83185b4d4f2f27e0f1af0ebf660eb9fa0a740b685b00a2db8a4
MD5 37d4c860f5d3627587b4449d7351256b
BLAKE2b-256 017c2453b166d06fbe4810c27f2b7426089881bb6782cf9982350eb2520f8ae4

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