github/langchain
1
0
Fork 0
mirror of https://github.com/hwchase17/langchain.git synced 2025-06-21 14:18:52 +00:00
Code Issues Packages Projects Releases Wiki Activity

community[patch]: Update doc-string in CloudBlobLoader (#22069)

Browse Source 
Update doc-string
This commit is contained in:
Eugene Yurtsev 2024-05-23 11:31:41 -04:00 committed by GitHub
parent 8ba4f77734
commit e5541d1da7
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 7 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
libs/community/langchain_community/document_loaders/blob_loaders/cloud_blob_loader.py
View File

@ -131,6 +131,7 @@ class CloudBlobLoader(BlobLoader):
.. code-block:: python .. code-block:: python
loader = CloudBlobLoader("s3://mybucket/id") loader = CloudBlobLoader("s3://mybucket/id")
for blob in loader.yield_blobs(): for blob in loader.yield_blobs():
print(blob) print(blob)
""" # noqa: E501 """ # noqa: E501
@ -145,10 +146,13 @@ class CloudBlobLoader(BlobLoader):
show_progress: bool = False, show_progress: bool = False,
) -> None: ) -> None:
"""Initialize with a url and how to glob over it. """Initialize with a url and how to glob over it.
Use [CloudPathLib](https://cloudpathlib.drivendata.org/). Use [CloudPathLib](https://cloudpathlib.drivendata.org/).
Args: Args:
url: Cloud URL to load from. url: Cloud URL to load from.
Supports s3://, az://, gs://, file:// schemes.
If no scheme is provided, it is assumed to be a local file.
If a path to a file is provided, glob/exclude/suffixes are ignored. If a path to a file is provided, glob/exclude/suffixes are ignored.
glob: Glob pattern relative to the specified path glob: Glob pattern relative to the specified path
by default set to pick up all non-hidden files by default set to pick up all non-hidden files
@ -252,6 +256,8 @@ class CloudBlobLoader(BlobLoader):
Args: Args:
path: path like object to file to be read path: path like object to file to be read
Supports s3://, az://, gs://, file:// schemes.
If no scheme is provided, it is assumed to be a local file.
encoding: Encoding to use if decoding the bytes into a string encoding: Encoding to use if decoding the bytes into a string
mime_type: if provided, will be set as the mime-type of the data mime_type: if provided, will be set as the mime-type of the data
guess_type: If True, the mimetype will be guessed from the file extension, guess_type: If True, the mimetype will be guessed from the file extension,