基类: BaseReader
Psychic 阅读器。
Psychic 是一个平台，允许通过一个通用 API 同步来自许多 SaaS 应用的数据。该阅读器连接到 Psychic 实例，并根据连接器 ID、账户 ID 和 API 密钥从其中读取数据。
在 docs.psychic.dev 了解更多信息。
参数
| 名称 |
类型 |
描述 |
默认值 |
psychic_key
|
str
|
Psychic 的密钥。请在 https://dashboard.psychic.dev/api-keys 获取。
|
None
|
源代码位于 llama-index-integrations/readers/llama-index-readers-psychic/llama_index/readers/psychic/base.py
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 | class PsychicReader(BaseReader):
"""
Psychic reader.
Psychic is a platform that allows syncing data from many SaaS apps through one
universal API.
This reader connects to an instance of Psychic and reads data from it, given a
connector ID, account ID, and API key.
Learn more at docs.psychic.dev.
Args:
psychic_key (str): Secret key for Psychic.
Get one at https://dashboard.psychic.dev/api-keys.
"""
def __init__(self, psychic_key: Optional[str] = None) -> None:
"""Initialize with parameters."""
try:
from psychicapi import ConnectorId, Psychic
except ImportError:
raise ImportError(
"`psychicapi` package not found, please run `pip install psychicapi`"
)
if psychic_key is None:
psychic_key = os.environ["PSYCHIC_SECRET_KEY"]
if psychic_key is None:
raise ValueError(
"Must specify `psychic_key` or set environment "
"variable `PSYCHIC_SECRET_KEY`."
)
self.psychic = Psychic(secret_key=psychic_key)
self.ConnectorId = ConnectorId
def load_data(
self, connector_id: Optional[str] = None, account_id: Optional[str] = None
) -> List[Document]:
"""
Load data from a Psychic connection.
Args:
connector_id (str): The connector ID to connect to
account_id (str): The account ID to connect to
Returns:
List[Document]: List of documents.
"""
if not connector_id or not account_id:
raise ValueError("Must specify both `connector_id` and `account_id`.")
if connector_id not in self.ConnectorId.__members__:
raise ValueError("Invalid connector ID.")
# get all the documents in the database
docs = []
data = self.psychic.get_documents(self.ConnectorId[connector_id], account_id)
for resource in data:
text = resource.get("content")
doc_id = resource.get("uri")
docs.append(
Document(
text=text,
id_=doc_id,
metadata={"connector_id": connector_id, "account_id": account_id},
)
)
return docs
|
load_data
load_data(connector_id: Optional[str] = None, account_id: Optional[str] = None) -> List[Document]
从 Psychic 连接加载数据。
参数
| 名称 |
类型 |
描述 |
默认值 |
connector_id
|
str
|
|
None
|
account_id
|
str
|
|
None
|
返回值
源代码位于 llama-index-integrations/readers/llama-index-readers-psychic/llama_index/readers/psychic/base.py
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 | def load_data(
self, connector_id: Optional[str] = None, account_id: Optional[str] = None
) -> List[Document]:
"""
Load data from a Psychic connection.
Args:
connector_id (str): The connector ID to connect to
account_id (str): The account ID to connect to
Returns:
List[Document]: List of documents.
"""
if not connector_id or not account_id:
raise ValueError("Must specify both `connector_id` and `account_id`.")
if connector_id not in self.ConnectorId.__members__:
raise ValueError("Invalid connector ID.")
# get all the documents in the database
docs = []
data = self.psychic.get_documents(self.ConnectorId[connector_id], account_id)
for resource in data:
text = resource.get("content")
doc_id = resource.get("uri")
docs.append(
Document(
text=text,
id_=doc_id,
metadata={"connector_id": connector_id, "account_id": account_id},
)
)
return docs
|
