基础： BaseReader
Firebase 实时数据库读取器。
从 Firebase 实时数据库检索数据，并将其转换为 LlamaIndex 使用的文档。
参数
| 名称 |
类型 |
描述 |
默认值 |
database_url
|
str
|
|
必需
|
service_account_key_path
|
Optional[str]
|
|
无
|
源代码位于 llama-index-integrations/readers/llama-index-readers-firebase-realtimedb/llama_index/readers/firebase_realtimedb/base.py
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86 | class FirebaseRealtimeDatabaseReader(BaseReader):
"""
Firebase Realtime Database reader.
Retrieves data from Firebase Realtime Database and converts it into the Document used by LlamaIndex.
Args:
database_url (str): Firebase Realtime Database URL.
service_account_key_path (Optional[str]): Path to the service account key file.
"""
def __init__(
self,
database_url: str,
service_account_key_path: Optional[str] = None,
) -> None:
"""Initialize with parameters."""
try:
import firebase_admin
from firebase_admin import credentials
except ImportError:
raise ImportError(
"`firebase_admin` package not found, please run `pip install"
" firebase-admin`"
)
if not firebase_admin._apps:
if service_account_key_path:
cred = credentials.Certificate(service_account_key_path)
firebase_admin.initialize_app(
cred, options={"databaseURL": database_url}
)
else:
firebase_admin.initialize_app(options={"databaseURL": database_url})
def load_data(self, path: str, field: Optional[str] = None) -> List[Document]:
"""
Load data from Firebase Realtime Database and convert it into documents.
Args:
path (str): Path to the data in the Firebase Realtime Database.
field (str, Optional): Key to pick data from
Returns:
List[Document]: A list of documents.
"""
try:
from firebase_admin import db
except ImportError:
raise ImportError(
"`firebase_admin` package not found, please run `pip install"
" firebase-admin`"
)
ref = db.reference(path)
data = ref.get()
documents = []
if isinstance(data, Dict):
for key in data:
entry = data[key]
extra_info = {
"document_id": key,
}
if type(entry) is Dict and field in entry:
text = entry[field]
else:
text = str(entry)
document = Document(text=text, extra_info=extra_info)
documents.append(document)
elif isinstance(data, str):
documents.append(Document(text=data))
return documents
|
load_data
load_data(path: str, field: Optional[str] = None) -> List[Document]
从 Firebase 实时数据库加载数据并将其转换为文档。
参数
| 名称 |
类型 |
描述 |
默认值 |
path
|
str
|
|
必需
|
field
|
(str, Optional)
|
|
无
|
返回
源代码位于 llama-index-integrations/readers/llama-index-readers-firebase-realtimedb/llama_index/readers/firebase_realtimedb/base.py
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86 | def load_data(self, path: str, field: Optional[str] = None) -> List[Document]:
"""
Load data from Firebase Realtime Database and convert it into documents.
Args:
path (str): Path to the data in the Firebase Realtime Database.
field (str, Optional): Key to pick data from
Returns:
List[Document]: A list of documents.
"""
try:
from firebase_admin import db
except ImportError:
raise ImportError(
"`firebase_admin` package not found, please run `pip install"
" firebase-admin`"
)
ref = db.reference(path)
data = ref.get()
documents = []
if isinstance(data, Dict):
for key in data:
entry = data[key]
extra_info = {
"document_id": key,
}
if type(entry) is Dict and field in entry:
text = entry[field]
else:
text = str(entry)
document = Document(text=text, extra_info=extra_info)
documents.append(document)
elif isinstance(data, str):
documents.append(Document(text=data))
return documents
|
