Share via

ai_analyze_sentiment function

  • Article

Applies to: check marked yes Databricks SQL check marked yes Databricks Runtime

Important

This feature is in Public Preview.

In the preview:

  • The underlying language model can handle several languages, however these functions are tuned for English.
  • There is rate limiting for the underlying Foundation Model APIs. See Foundation Model APIs limits to update these limits.
  • A conservative default rate limit is applied to this function. For high throughput applications contact support.

The ai_analyze_sentiment() function allows you to invoke a state-of-the-art generative AI model to perform sentiment analysis on input text using SQL.

Requirements

Important

The underlying models that might be used at this time are licensed under the Apache 2.0 License, Copyright © The Apache Software Foundation or the LLAMA 3.3 Community License Copyright © Meta Platforms, Inc. All rights reserved. Customers are responsible for ensuring compliance with applicable model licenses.

Databricks recommends reviewing these licenses to ensure compliance with any applicable terms. If models emerge in the future that perform better according to Databricks’s internal benchmarks, Databricks might change the model (and the list of applicable licenses provided on this page).

Note

In Databricks Runtime 15.1 and above, this function is supported in Databricks notebooks, including notebooks that are run as a task in a Databricks workflow.

Syntax

ai_analyze_sentiment(content)

Arguments

  • content: A STRING expression, the text to be analyzed.

Returns

A STRING. The value is chosen from 'positive', 'negative', 'neutral', or 'mixed'. Returns null if the sentiment cannot be detected.

Examples

> SELECT ai_analyze_sentiment('I am happy');
  positive

> SELECT ai_analyze_sentiment('I am sad');
  negative