Loaders
__all__ = ['BaseLoader', 'TextLoader', 'PdfLoader', 'WebLoader', 'SqlLoader', 'CsvLoader', 'DataFrameLoader', 'FileLoader', 'EmailLoader']
module-attribute
BaseLoader
Bases: ABC
Source code in griptape/griptape/loaders/base_loader.py
futures_executor: futures.Executor = field(default=Factory(lambda : futures.ThreadPoolExecutor()), kw_only=True)
class-attribute
instance-attribute
load(*args, **kwargs)
abstractmethod
CsvLoader
Bases: BaseLoader
Source code in griptape/griptape/loaders/csv_loader.py
delimiter: str = field(default=',', kw_only=True)
class-attribute
instance-attribute
embedding_driver: Optional[BaseEmbeddingDriver] = field(default=None, kw_only=True)
class-attribute
instance-attribute
load(filename)
load_collection(filenames)
Source code in griptape/griptape/loaders/csv_loader.py
DataFrameLoader
Bases: BaseLoader
Source code in griptape/griptape/loaders/dataframe_loader.py
embedding_driver: Optional[BaseEmbeddingDriver] = field(default=None, kw_only=True)
class-attribute
instance-attribute
load(dataframe)
load_collection(dataframes)
Source code in griptape/griptape/loaders/dataframe_loader.py
EmailLoader
Bases: BaseLoader
Source code in griptape/griptape/loaders/email_loader.py
imap_url: str = field(kw_only=True)
class-attribute
instance-attribute
password: str = field(kw_only=True)
class-attribute
instance-attribute
username: str = field(kw_only=True)
class-attribute
instance-attribute
EmailQuery
An email retrieval query
Attributes:
Name | Type | Description |
---|---|---|
label |
str
|
Label to retrieve emails from such as 'INBOX' or 'SENT'. |
key |
Optional[str]
|
Optional key for filtering such as 'FROM' or 'SUBJECT'. |
search_criteria |
Optional[str]
|
Optional search criteria to filter emails by key. |
max_count |
Optional[int]
|
Optional max email count. |
Source code in griptape/griptape/loaders/email_loader.py
key: Optional[str] = field(default=None, kw_only=True)
class-attribute
instance-attribute
label: str = field(kw_only=True)
class-attribute
instance-attribute
max_count: Optional[int] = field(default=None, kw_only=True)
class-attribute
instance-attribute
search_criteria: Optional[str] = field(default=None, kw_only=True)
class-attribute
instance-attribute
load(query)
load_collection(queries)
Source code in griptape/griptape/loaders/email_loader.py
FileLoader
Bases: BaseLoader
Source code in griptape/griptape/loaders/file_loader.py
encoding: Optional[str] = field(default=None, kw_only=True)
class-attribute
instance-attribute
file_to_artifact(path)
Source code in griptape/griptape/loaders/file_loader.py
load(path)
load_collection(paths)
Source code in griptape/griptape/loaders/file_loader.py
PdfLoader
Bases: TextLoader
Source code in griptape/griptape/loaders/pdf_loader.py
chunker: PdfChunker = field(default=Factory(lambda : PdfChunker(tokenizer=self.tokenizer, max_tokens=self.max_tokens), takes_self=True), kw_only=True)
class-attribute
instance-attribute
load(stream, password=None)
load_collection(streams, password=None)
Source code in griptape/griptape/loaders/pdf_loader.py
SqlLoader
Bases: BaseLoader
Source code in griptape/griptape/loaders/sql_loader.py
embedding_driver: Optional[BaseEmbeddingDriver] = field(default=None, kw_only=True)
class-attribute
instance-attribute
sql_driver: BaseSqlDriver = field(kw_only=True)
class-attribute
instance-attribute
load(select_query)
load_collection(select_queries)
Source code in griptape/griptape/loaders/sql_loader.py
TextLoader
Bases: BaseLoader
Source code in griptape/griptape/loaders/text_loader.py
MAX_TOKEN_RATIO = 0.5
class-attribute
instance-attribute
chunker: TextChunker = field(default=Factory(lambda : TextChunker(tokenizer=self.tokenizer, max_tokens=self.max_tokens), takes_self=True), kw_only=True)
class-attribute
instance-attribute
embedding_driver: Optional[BaseEmbeddingDriver] = field(default=None, kw_only=True)
class-attribute
instance-attribute
encoding: str = field(default='utf-8', kw_only=True)
class-attribute
instance-attribute
max_tokens: int = field(default=Factory(lambda : round(self.tokenizer.max_tokens * self.MAX_TOKEN_RATIO), takes_self=True), kw_only=True)
class-attribute
instance-attribute
tokenizer: OpenAiTokenizer = field(default=Factory(lambda : OpenAiTokenizer(model=OpenAiTokenizer.DEFAULT_OPENAI_GPT_3_CHAT_MODEL)), kw_only=True)
class-attribute
instance-attribute
load(text)
load_collection(texts)
text_to_artifacts(text)
Source code in griptape/griptape/loaders/text_loader.py
WebLoader
Bases: TextLoader