Use this extension to get toxicity scores from
Perspective
API
for comments
written to a Cloud Firestore collection.
This extension runs Perspective API on the text field and collection you
configure. The API uses machine learning models to score the perceived impact a
comment might have on a conversation by evaluating that comment across a range
of emotional concepts, called attributes. When you install this extension, you
will specify the attributes you want to receive scores for. Perspective’s main
attribute is TOXICITY, defined as “a rude, disrespectful, or unreasonable
comment that is likely to make you leave a discussion”. See a
list of all
available attributes
on our developer site.
Scores are retrieved when a new document is added to your collection or an
existing document is modified.
Additional setup
Before you can use this extension, you will need to enable Perspective API.
Follow
the instructions on our Get Started page
to request API access and then
enable the API and create an API
key
.
By default, you’re granted quota for 1 query per second (QPS) to Perspective
API. For additional QPS, fill out a
quota increase
request
as needed.
Note:
If you add or update documents at a rate higher than your allotted QPS,
you may exceed quota and the extension will fail to score your documents.
Billing
Perspective API is
free
for all amounts of quota. However, the extension
uses Firebase and Google Cloud Platform services which may have associated
charges, including:
- Cloud Firestore
- Cloud Functions
When you use Firebase Extensions, you’re only charged for the underlying
resources that you use. A paid-tier billing plan is only required if the
extension uses a service that requires a paid-tier plan, for example calling to
a Google Cloud API or making outbound network requests to non-Google services.
All Firebase services offer a free tier of usage.
Learn more about Firebase billing.
