Skip to content

Latest commit

 

History

History
 
 

storage-extract-image-text

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
functions
functions
 
 
CHANGELOG.md
CHANGELOG.md
 
 
POSTINSTALL.md
POSTINSTALL.md
 
 
PREINSTALL.md
PREINSTALL.md
 
 
README.md
README.md
 
 
extension.yaml
extension.yaml
 
 

README.md

Image Text Extraction

Author: Firebase (https://firebase.google.com)

Description: Extracts text from images uploaded to storage and writes extracted text to Firestore.

🧩 Install this experimental extension

⚠️ Experimental: This extension is available for testing as an experimental release. It has not been as thoroughly tested as the officially released extensions, and future updates might introduce breaking changes. If you use this extension, please report bugs and make feature requests in our GitHub repository.

Console

Install this extension in your Firebase project

Firebase CLI

firebase ext:install storage-extract-image-text --project=<your-project-id>

Learn more about installing extensions in the Firebase Extensions documentation: console, CLI

Details: This extension will extract text from any jpg or png images uploaded to Cloud Storage and write the extracted text to Firestore.

Billing

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

  • Cloud Functions
  • Cloud Vision API
  • Cloud Storage
  • Cloud Firestore

When you use Firebase Extensions, you're only charged for the underlying resources that you use. A paid-tier (Blaze) billing plan is required because the extension uses Cloud Vision API.

Configuration Parameters:

  • Cloud Functions location: Where do you want to deploy the functions created for this extension? You usually want a location close to your database. Realtime Database instances are located in us-central1. For help selecting a location, refer to the location selection guide.

  • Cloud Storage bucket for images: To which Cloud Storage bucket will you upload images from which you want to extract text?

  • Collection path: What is the path to the collection where extracted text will be written to.

Cloud Functions:

  • extractText: Listens to incoming Storage documents, executes OCR on them and writes extracted text to Firestore into a preconfigured collection.

APIs Used:

  • vision.googleapis.com (Reason: Powers all Vision tasks performed by the extension.)

Access Required:

This extension will operate with the following project IAM roles:

  • storage.admin (Reason: Allows the extension to write to your Cloud Storage.)

  • datastore.user (Reason: Allows the extension to write to your Firestore Database instance.)