Skip to content

Latest commit

 

History

History
46 lines (37 loc) · 2.3 KB

PREINSTALL.md

File metadata and controls

46 lines (37 loc) · 2.3 KB
Raw

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 string field you specify for each document in your collection. 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 website. Scores are retrieved when a 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 QPS to Perspective API. For additional QPS, fill out a quota increase request as needed. Note that 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

This extension uses other Firebase or Google Cloud services which may have associated charges:

  • 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.

Perspective API is free for all amounts of quota. Any costs associated with this extension come from the Firebase and Google Cloud Platform services listed above.