Free cookie consent management tool by TermsFeed

a!sentimentScore() Function

The capabilities described on this page are included in Appian's advanced and premium capability tiers. Usage limits may apply.

Function
Copy link to clipboard

a!sentimentScore( text )

Returns a list of scores representing the emotional or subjective sentiment expressed in each of the provided text values, ranging from 1.0 (positive) to -1.0 (negative).

Parameters
Copy link to clipboard

Keyword Type Description

text

List of Text String

The text values from which to extract sentiment scores. For best results, use values that are about the length of a sentence.

Returns
Copy link to clipboard

List of Decimal

Usage considerations
Copy link to clipboard

Considerations for Appian Cloud users
Copy link to clipboard

Note:  Attention Appian Cloud FedRAMP, HIPAA, or PCI-DSS customers: The Sentiment Score function is not certified as FedRAMP, HIPAA, or PCI-DSS compliant. Customers should use caution when using a!sentimentScore() with regulated data, and review for their own compliance requirements.

This function is available only on Appian Cloud and will be enabled on Cloud sites on a rolling basis. You will receive the following error until your site is enabled: This function is currently unavailable. Please contact your system administrator if this problem persists.

Supported text values
Copy link to clipboard

  • Supports US English text only.

  • Single large text values will typically not provide useful sentiment scores. For best results, split large values into a list of smaller values that are each about the length of a sentence.

Autoscaled process models and application performance
Copy link to clipboard

Using this function in a process model with autoscale enabled may result in degraded site or application performance. It should be used with caution and tested thoroughly before deploying it for real-world use. When the application is in production, use the Autoscaled Process Activity tab to monitor how the process performs at scale.

Examples
Copy link to clipboard

You can copy and paste these examples into the Expression Rule Designer to see how this works.

Positive sentiment score
Copy link to clipboard

1

=a!sentimentScore({"Hi, I hope you're having a great day"})

Copy

returns

  {0.79}

Negative sentiment score
Copy link to clipboard

1

=a!sentimentScore({"I got the wrong shipment!"})

Copy

returns

	{-0.53}

Returning sentiment scores for multiple statements at once
Copy link to clipboard

1
2
3
4
5
6

=a!sentimentScore(
  {
    "I lost my wallet and was having a horrible day!",
    "Then someone returned it to me and I was so happy!"
  }
)

Copy

returns

  {-0.73, 0.72}

Feature compatibility
Copy link to clipboard

The table below lists this function's compatibility with various features in Appian.
Feature Compatibility Note
Portals Partially compatible

Can be used with Appian Portals if it is connected using an integration and web API.
Offline Mobile Compatible
Sync-Time Custom Record Fields Incompatible
Real-Time Custom Record Fields Incompatible

Custom record fields that evaluate in real time must be configured using one or more Custom Field functions.
Process Reports Incompatible

Cannot be used to configure a process report.
Process Events Incompatible

Cannot be used to configure a process event node, such as a start event or timer event.
Process Autoscaling Partially compatible

Using this function in a process model with autoscale enabled may result in degraded site or application performance.

Feedback
Copy link to clipboard