Skip to main content

llama-index readers firestore integration

Project description

Firestore Loader

pip install llama-index-readers-firestore

This loader loads from a Firestore collection or a specific document from Firestore. The loader assumes your project already has the google cloud credentials loaded. To find out how to set up credentials, see here.

Usage

To initialize the loader, provide the project-id of the google cloud project.

Initializing the reader

from llama_index.readers.firestore import FirestoreReader

reader = FirestoreReader(project_id="<Your Project ID>")

Loading Data from a Firestore Collection

Load data from a Firestore collection with the load_data method: The collection path should include all previous documents and collections if it is a nested collection.

documents = reader.load_data(collection="foo/bar/abc/")

Loading a Single Document from Firestore

Load a single document from Firestore with the load_document method:

document = reader.load_document(document_url="foo/bar/abc/MY_DOCUMENT")

Note: load_data returns a list of Document objects, whereas load_document returns a single Document object.

This loader is designed to be used as a way to load data into LlamaIndex.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

llama_index_readers_firestore-0.5.0.tar.gz (4.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

llama_index_readers_firestore-0.5.0-py3-none-any.whl (4.0 kB view details)

Uploaded Python 3

File details

Details for the file llama_index_readers_firestore-0.5.0.tar.gz.

File metadata

  • Download URL: llama_index_readers_firestore-0.5.0.tar.gz
  • Upload date:
  • Size: 4.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.10.9 {"installer":{"name":"uv","version":"0.10.9","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for llama_index_readers_firestore-0.5.0.tar.gz
Algorithm Hash digest
SHA256 2ae7ac8da38335c5f1adbd34915369b7ebeca55841641859ae2012872284473a
MD5 9b130ec2cc46eaf2411aab5143ae4a7f
BLAKE2b-256 0130629ff3033ccdae1c88375330fb5b21d78f25d28cc94848849a225c53b729

See more details on using hashes here.

File details

Details for the file llama_index_readers_firestore-0.5.0-py3-none-any.whl.

File metadata

  • Download URL: llama_index_readers_firestore-0.5.0-py3-none-any.whl
  • Upload date:
  • Size: 4.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.10.9 {"installer":{"name":"uv","version":"0.10.9","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for llama_index_readers_firestore-0.5.0-py3-none-any.whl
Algorithm Hash digest
SHA256 c095e73ed0cd8d1722d9e04ea321ef65ff01d7dcd5ac196d9044251f6d26bdee
MD5 e223f5229f58d3fdc9253afb6197e14e
BLAKE2b-256 e925f25e35d59ad742950a41edb0a5c397f04550cfed23d8e90d428d3805eaf5

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page