AWS Comprehend component

The aws2-comprehend component analyses text with Amazon Comprehend: sentiment, language, entities, key phrases, PII, syntax, toxicity and custom classification.

Scheme: aws2-comprehend: · Also: aws-comprehend: (same component) · Crate: cameleer-cloud · Cargo feature: cloud · Consumer: no · Producer: yes · Apache Camel: camel-aws-comprehend (see the component list)

When to use it

• Route customer messages by sentiment (escalate negative reviews).
• Detect and redact personal data (PII) before text is stored or sent to an LLM.
• Detect the language of a message before translating it.
• Give an AI agent a cheap, deterministic text-analysis tool next to the model.

URI format

aws2-comprehend://label?operation=...[&options]

Example

Escalate negative product reviews:

- route:
    id: review-sentiment
    from:
      uri: "aws2-sqs://reviews?region={{env:AWS_REGION:us-east-1}}"
      steps:
        - setProperty:
            name: review
            simple: "${body}"
        - to: "aws2-comprehend://reviews?region={{env:AWS_REGION:us-east-1}}&operation=detectSentiment&languageCode=en"
        - choice:
            when:
              - simple: "${body} == 'NEGATIVE'"
                steps:
                  - setBody:
                      simple: "${exchangeProperty.review}"
                  - to: "aws2-sqs://escalations?region={{env:AWS_REGION:us-east-1}}&autoCreateQueue=true"
            otherwise:
              steps:
                - log: "review sentiment: ${body}"

detectSentiment replaces the body with the sentiment (POSITIVE, NEGATIVE, NEUTRAL or MIXED) and sets the scores in CamelAwsComprehendSentimentScore, so the original text is kept in a property.

Rust DSL

ctx.add_routes(|b| {
    b.from("aws2-sqs://reviews?region={{env:AWS_REGION:us-east-1}}")
        .set_property("review", simple("${body}"))
        .to("aws2-comprehend://reviews?region={{env:AWS_REGION:us-east-1}}&operation=detectSentiment&languageCode=en")
        .choice()
            .when(simple("${body} == 'NEGATIVE'"))
                .set_body(simple("${exchangeProperty.review}"))
                .to("aws2-sqs://escalations?region={{env:AWS_REGION:us-east-1}}&autoCreateQueue=true")
            .otherwise()
                .log("review sentiment: ${body}")
        .end();
})?;

Options

Common AWS options (region, credentials, endpoint override, proxy) are listed in Cloud credentials.

Message headers

Run it with Docker

docker run --rm -e AWS_REGION -e AWS_ACCESS_KEY_ID -e AWS_SECRET_ACCESS_KEY \
  -v "$PWD:/routes:ro" pmsudhi/cameleer run /routes/reviews.camel.yaml

Common questions

How do I find personal data in a message?

Use operation=detectPiiEntities: the body becomes the list of entities with their type and offsets, which you can use to mask the text. containsPiiEntities only tells which kinds are present.

How do I detect the language and then translate?

Call detectDominantLanguage, keep the text in a property, and pass ${header.CamelAwsComprehendDetectedLanguage} as the source language to aws2-translate.

Related

• AWS Translate, AWS Bedrock, AWS Textract
• Cloud credentials

Found a problem?

If something on this page doesn't match what Cameleer does, or you hit a bug while building with it, please help fix it, whether you are a person or a coding agent: open an issue that describes what you saw, then fork the repository, fix it, add or update a test, run cargo test --workspace, and open a pull request. CONTRIBUTING.md explains the ground rules.